Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 49 additions & 10 deletions samples/word/35-ranges/get-pages.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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() {
Expand All @@ -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);
}

Expand Down Expand Up @@ -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);
}

Expand Down Expand Up @@ -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);
}

Expand Down Expand Up @@ -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);
}

Expand All @@ -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;
Expand Down Expand Up @@ -226,6 +259,12 @@ template:
<button id="get-all-pages" class="ms-Button">
<span class="ms-Button-label">Get all pages</span>
</button>
<button id="get-all-panes" class="ms-Button">
<span class="ms-Button-label">Get all panes</span>
</button>
<button id="get-all-windows" class="ms-Button">
<span class="ms-Button-label">Get all windows</span>
</button>
</section>
language: html
style:
Expand Down
Binary file modified snippet-extractor-metadata/word.xlsx
Binary file not shown.
77 changes: 55 additions & 22 deletions snippet-extractor-output/snippets.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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);
}

Expand Down Expand Up @@ -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);
}

Expand Down Expand Up @@ -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);
}

Expand Down Expand Up @@ -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);
}

Expand Down Expand Up @@ -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);
}

Expand Down Expand Up @@ -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);
}

Expand Down Expand Up @@ -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);
}

Expand Down Expand Up @@ -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);
}

Expand All @@ -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:
Expand Down Expand Up @@ -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);
}

Expand Down Expand Up @@ -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);
}

Expand All @@ -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}`);
});