diff --git a/samples/word/35-ranges/get-pages.yaml b/samples/word/35-ranges/get-pages.yaml
index ac6000b3d..c4b6584a3 100644
--- a/samples/word/35-ranges/get-pages.yaml
+++ b/samples/word/35-ranges/get-pages.yaml
@@ -9,9 +9,15 @@ api_set:
script:
content: |
document.getElementById("get-pages-selected-range").addEventListener("click", () => tryCatch(getPagesOfSelectedRange));
- document.getElementById("get-pages-third-paragraph").addEventListener("click", () => tryCatch(getPagesOfThirdParagraph));
- document.getElementById("get-pages-enclosing-viewport").addEventListener("click", () => tryCatch(getPagesEnclosingViewport));
+ document
+ .getElementById("get-pages-third-paragraph")
+ .addEventListener("click", () => tryCatch(getPagesOfThirdParagraph));
+ document
+ .getElementById("get-pages-enclosing-viewport")
+ .addEventListener("click", () => tryCatch(getPagesEnclosingViewport));
document.getElementById("get-all-pages").addEventListener("click", () => tryCatch(getAllPages));
+ document.getElementById("get-all-panes").addEventListener("click", () => tryCatch(getAllPanes));
+ document.getElementById("get-all-windows").addEventListener("click", () => tryCatch(getAllWindows));
document.getElementById("setup").addEventListener("click", () => tryCatch(setup));
async function getPagesOfSelectedRange() {
@@ -27,11 +33,11 @@ script:
const pagesText = [];
for (let i = 0; i < pages.items.length; i++) {
const page = pages.items[i];
- page.load('index');
+ page.load("index");
pagesIndexes.push(page);
const range = page.getRange();
- range.load('text');
+ range.load("text");
pagesText.push(range);
}
@@ -63,11 +69,11 @@ script:
const pagesText = [];
for (let i = 0; i < pages.items.length; i++) {
const page = pages.items[i];
- page.load('index');
+ page.load("index");
pagesIndexes.push(page);
const range = page.getRange();
- range.load('text');
+ range.load("text");
pagesText.push(range);
}
@@ -106,7 +112,7 @@ script:
const pagesIndexes = [];
for (let i = 0; i < pageCount; i++) {
const page = pages.items[i];
- page.load('index');
+ page.load("index");
pagesIndexes.push(page);
}
@@ -143,15 +149,15 @@ script:
const pagesFirstParagraphText = [];
for (let i = 0; i < pages.items.length; i++) {
const page = pages.items[i];
- page.load('index');
+ page.load("index");
pagesIndexes.push(page);
const paragraphs = page.getRange().paragraphs;
- paragraphs.load('items/length');
+ paragraphs.load("items/length");
pagesNumberOfParagraphs.push(paragraphs);
const firstParagraph = paragraphs.getFirst();
- firstParagraph.load('text');
+ firstParagraph.load("text");
pagesFirstParagraphText.push(firstParagraph);
}
@@ -165,6 +171,33 @@ script:
});
}
+ async function getAllPanes() {
+ await Word.run(async (context) => {
+ // Gets all the panes in the active document window.
+
+ // Get the active window.
+ const activeWindow: Word.Window = context.document.activeWindow;
+ activeWindow.load("panes/items/length");
+
+ await context.sync();
+
+ const panes: Word.PaneCollection = activeWindow.panes;
+ console.log(`Number of panes in the current document window: ${panes.items.length}`);
+ });
+ }
+
+ async function getAllWindows() {
+ await Word.run(async (context) => {
+ // Gets the document windows.
+ const windows: Word.WindowCollection = context.document.windows;
+ windows.load("windows/items/length");
+
+ await context.sync();
+
+ console.log(`Number of windows for this document: ${windows.items.length}`);
+ });
+ }
+
async function setup() {
await Word.run(async (context) => {
const body: Word.Body = context.document.body;
@@ -226,6 +259,12 @@ template:
+
+
language: html
style:
diff --git a/snippet-extractor-metadata/word.xlsx b/snippet-extractor-metadata/word.xlsx
index a3ceb2436..129c07263 100644
Binary files a/snippet-extractor-metadata/word.xlsx and b/snippet-extractor-metadata/word.xlsx differ
diff --git a/snippet-extractor-output/snippets.yaml b/snippet-extractor-output/snippets.yaml
index 33f3fdacd..d95f50678 100644
--- a/snippet-extractor-output/snippets.yaml
+++ b/snippet-extractor-output/snippets.yaml
@@ -23972,15 +23972,15 @@ Word.Document#activeWindow:member:
const pagesFirstParagraphText = [];
for (let i = 0; i < pages.items.length; i++) {
const page = pages.items[i];
- page.load('index');
+ page.load("index");
pagesIndexes.push(page);
const paragraphs = page.getRange().paragraphs;
- paragraphs.load('items/length');
+ paragraphs.load("items/length");
pagesNumberOfParagraphs.push(paragraphs);
const firstParagraph = paragraphs.getFirst();
- firstParagraph.load('text');
+ firstParagraph.load("text");
pagesFirstParagraphText.push(firstParagraph);
}
@@ -25975,11 +25975,11 @@ Word.Page:class:
const pagesText = [];
for (let i = 0; i < pages.items.length; i++) {
const page = pages.items[i];
- page.load('index');
+ page.load("index");
pagesIndexes.push(page);
const range = page.getRange();
- range.load('text');
+ range.load("text");
pagesText.push(range);
}
@@ -26008,11 +26008,11 @@ Word.Page#getRange:member(1):
const pagesText = [];
for (let i = 0; i < pages.items.length; i++) {
const page = pages.items[i];
- page.load('index');
+ page.load("index");
pagesIndexes.push(page);
const range = page.getRange();
- range.load('text');
+ range.load("text");
pagesText.push(range);
}
@@ -26047,11 +26047,11 @@ Word.Page#index:member:
const pagesText = [];
for (let i = 0; i < pages.items.length; i++) {
const page = pages.items[i];
- page.load('index');
+ page.load("index");
pagesIndexes.push(page);
const range = page.getRange();
- range.load('text');
+ range.load("text");
pagesText.push(range);
}
@@ -26080,11 +26080,11 @@ Word.PageCollection:class:
const pagesText = [];
for (let i = 0; i < pages.items.length; i++) {
const page = pages.items[i];
- page.load('index');
+ page.load("index");
pagesIndexes.push(page);
const range = page.getRange();
- range.load('text');
+ range.load("text");
pagesText.push(range);
}
@@ -26125,15 +26125,15 @@ Word.Pane:class:
const pagesFirstParagraphText = [];
for (let i = 0; i < pages.items.length; i++) {
const page = pages.items[i];
- page.load('index');
+ page.load("index");
pagesIndexes.push(page);
const paragraphs = page.getRange().paragraphs;
- paragraphs.load('items/length');
+ paragraphs.load("items/length");
pagesNumberOfParagraphs.push(paragraphs);
const firstParagraph = paragraphs.getFirst();
- firstParagraph.load('text');
+ firstParagraph.load("text");
pagesFirstParagraphText.push(firstParagraph);
}
@@ -26175,15 +26175,15 @@ Word.Pane#pages:member:
const pagesFirstParagraphText = [];
for (let i = 0; i < pages.items.length; i++) {
const page = pages.items[i];
- page.load('index');
+ page.load("index");
pagesIndexes.push(page);
const paragraphs = page.getRange().paragraphs;
- paragraphs.load('items/length');
+ paragraphs.load("items/length");
pagesNumberOfParagraphs.push(paragraphs);
const firstParagraph = paragraphs.getFirst();
- firstParagraph.load('text');
+ firstParagraph.load("text");
pagesFirstParagraphText.push(firstParagraph);
}
@@ -26226,7 +26226,7 @@ Word.Pane#pagesEnclosingViewport:member:
const pagesIndexes = [];
for (let i = 0; i < pageCount; i++) {
const page = pages.items[i];
- page.load('index');
+ page.load("index");
pagesIndexes.push(page);
}
@@ -26236,6 +26236,24 @@ Word.Pane#pagesEnclosingViewport:member:
console.log(`Page index: ${pagesIndexes[i].index}`);
}
});
+Word.PaneCollection:class:
+ - >-
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/35-ranges/get-pages.yaml
+
+
+ await Word.run(async (context) => {
+ // Gets all the panes in the active document window.
+
+ // Get the active window.
+ const activeWindow: Word.Window = context.document.activeWindow;
+ activeWindow.load("panes/items/length");
+
+ await context.sync();
+
+ const panes: Word.PaneCollection = activeWindow.panes;
+ console.log(`Number of panes in the current document window: ${panes.items.length}`);
+ });
Word.Paragraph:class:
- >-
// Link to full sample:
@@ -28985,15 +29003,15 @@ Word.Window:class:
const pagesFirstParagraphText = [];
for (let i = 0; i < pages.items.length; i++) {
const page = pages.items[i];
- page.load('index');
+ page.load("index");
pagesIndexes.push(page);
const paragraphs = page.getRange().paragraphs;
- paragraphs.load('items/length');
+ paragraphs.load("items/length");
pagesNumberOfParagraphs.push(paragraphs);
const firstParagraph = paragraphs.getFirst();
- firstParagraph.load('text');
+ firstParagraph.load("text");
pagesFirstParagraphText.push(firstParagraph);
}
@@ -29036,7 +29054,7 @@ Word.Window#activePane:member:
const pagesIndexes = [];
for (let i = 0; i < pageCount; i++) {
const page = pages.items[i];
- page.load('index');
+ page.load("index");
pagesIndexes.push(page);
}
@@ -29046,3 +29064,18 @@ Word.Window#activePane:member:
console.log(`Page index: ${pagesIndexes[i].index}`);
}
});
+Word.WindowCollection:class:
+ - >-
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/35-ranges/get-pages.yaml
+
+
+ await Word.run(async (context) => {
+ // Gets the document windows.
+ const windows: Word.WindowCollection = context.document.windows;
+ windows.load("windows/items/length");
+
+ await context.sync();
+
+ console.log(`Number of windows for this document: ${windows.items.length}`);
+ });