diff --git a/docs/docs-ref-autogen/word/word/word.document.yml b/docs/docs-ref-autogen/word/word/word.document.yml index 98b841cb59..7a989a7c22 100644 --- a/docs/docs-ref-autogen/word/word/word.document.yml +++ b/docs/docs-ref-autogen/word/word/word.document.yml @@ -116,15 +116,15 @@ properties: 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); } diff --git a/docs/docs-ref-autogen/word/word/word.page.yml b/docs/docs-ref-autogen/word/word/word.page.yml index 6dc5d1b679..c436cfe069 100644 --- a/docs/docs-ref-autogen/word/word/word.page.yml +++ b/docs/docs-ref-autogen/word/word/word.page.yml @@ -32,11 +32,11 @@ remarks: >- 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); } @@ -140,11 +140,11 @@ properties: 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); } @@ -254,11 +254,11 @@ methods: 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); } diff --git a/docs/docs-ref-autogen/word/word/word.pagecollection.yml b/docs/docs-ref-autogen/word/word/word.pagecollection.yml index bc2f8c8d44..aaa7e4c4b5 100644 --- a/docs/docs-ref-autogen/word/word/word.pagecollection.yml +++ b/docs/docs-ref-autogen/word/word/word.pagecollection.yml @@ -30,11 +30,11 @@ remarks: >- 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); } diff --git a/docs/docs-ref-autogen/word/word/word.pane.yml b/docs/docs-ref-autogen/word/word/word.pane.yml index 6da00c828b..849049e274 100644 --- a/docs/docs-ref-autogen/word/word/word.pane.yml +++ b/docs/docs-ref-autogen/word/word/word.pane.yml @@ -45,15 +45,15 @@ remarks: >- 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); } @@ -130,15 +130,15 @@ properties: 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); } @@ -205,7 +205,7 @@ properties: const pagesIndexes = []; for (let i = 0; i < pageCount; i++) { const page = pages.items[i]; - page.load('index'); + page.load("index"); pagesIndexes.push(page); } diff --git a/docs/docs-ref-autogen/word/word/word.panecollection.yml b/docs/docs-ref-autogen/word/word/word.panecollection.yml index e1d56f75f6..80c7df96e9 100644 --- a/docs/docs-ref-autogen/word/word/word.panecollection.yml +++ b/docs/docs-ref-autogen/word/word/word.panecollection.yml @@ -8,6 +8,31 @@ remarks: >- \[ [API set: WordApiDesktop 1.2](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + #### Examples + + + ```TypeScript + + // 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}`); + }); + + ``` + isPreview: false isDeprecated: false type: class diff --git a/docs/docs-ref-autogen/word/word/word.window.yml b/docs/docs-ref-autogen/word/word/word.window.yml index e36d6688ed..5fda80f665 100644 --- a/docs/docs-ref-autogen/word/word/word.window.yml +++ b/docs/docs-ref-autogen/word/word/word.window.yml @@ -44,15 +44,15 @@ remarks: >- 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); } @@ -115,7 +115,7 @@ properties: const pagesIndexes = []; for (let i = 0; i < pageCount; i++) { const page = pages.items[i]; - page.load('index'); + page.load("index"); pagesIndexes.push(page); } diff --git a/docs/docs-ref-autogen/word/word/word.windowcollection.yml b/docs/docs-ref-autogen/word/word/word.windowcollection.yml index 3c462e53d4..9b5d985b50 100644 --- a/docs/docs-ref-autogen/word/word/word.windowcollection.yml +++ b/docs/docs-ref-autogen/word/word/word.windowcollection.yml @@ -8,6 +8,28 @@ remarks: >- \[ [API set: WordApiDesktop 1.2](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + #### Examples + + + ```TypeScript + + // 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}`); + }); + + ``` + isPreview: false isDeprecated: false type: class diff --git a/docs/docs-ref-autogen/word_desktop_1_2/word/word.document.yml b/docs/docs-ref-autogen/word_desktop_1_2/word/word.document.yml index 621e8b0af9..21ca11a3ac 100644 --- a/docs/docs-ref-autogen/word_desktop_1_2/word/word.document.yml +++ b/docs/docs-ref-autogen/word_desktop_1_2/word/word.document.yml @@ -86,15 +86,15 @@ properties: 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); } diff --git a/docs/docs-ref-autogen/word_desktop_1_2/word/word.page.yml b/docs/docs-ref-autogen/word_desktop_1_2/word/word.page.yml index 52730a6546..ce06a7dfb1 100644 --- a/docs/docs-ref-autogen/word_desktop_1_2/word/word.page.yml +++ b/docs/docs-ref-autogen/word_desktop_1_2/word/word.page.yml @@ -32,11 +32,11 @@ remarks: >- 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); } @@ -125,11 +125,11 @@ properties: 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); } @@ -239,11 +239,11 @@ methods: 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); } diff --git a/docs/docs-ref-autogen/word_desktop_1_2/word/word.pagecollection.yml b/docs/docs-ref-autogen/word_desktop_1_2/word/word.pagecollection.yml index bc2f8c8d44..aaa7e4c4b5 100644 --- a/docs/docs-ref-autogen/word_desktop_1_2/word/word.pagecollection.yml +++ b/docs/docs-ref-autogen/word_desktop_1_2/word/word.pagecollection.yml @@ -30,11 +30,11 @@ remarks: >- 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); } diff --git a/docs/docs-ref-autogen/word_desktop_1_2/word/word.pane.yml b/docs/docs-ref-autogen/word_desktop_1_2/word/word.pane.yml index eb1bb7a62a..b6a3d2346b 100644 --- a/docs/docs-ref-autogen/word_desktop_1_2/word/word.pane.yml +++ b/docs/docs-ref-autogen/word_desktop_1_2/word/word.pane.yml @@ -45,15 +45,15 @@ remarks: >- 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); } @@ -130,15 +130,15 @@ properties: 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); } @@ -205,7 +205,7 @@ properties: const pagesIndexes = []; for (let i = 0; i < pageCount; i++) { const page = pages.items[i]; - page.load('index'); + page.load("index"); pagesIndexes.push(page); } diff --git a/docs/docs-ref-autogen/word_desktop_1_2/word/word.panecollection.yml b/docs/docs-ref-autogen/word_desktop_1_2/word/word.panecollection.yml index a7f960cd96..81b92a396a 100644 --- a/docs/docs-ref-autogen/word_desktop_1_2/word/word.panecollection.yml +++ b/docs/docs-ref-autogen/word_desktop_1_2/word/word.panecollection.yml @@ -8,6 +8,31 @@ remarks: >- \[ [API set: WordApiDesktop 1.2](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + #### Examples + + + ```TypeScript + + // 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}`); + }); + + ``` + isPreview: false isDeprecated: false type: class diff --git a/docs/docs-ref-autogen/word_desktop_1_2/word/word.window.yml b/docs/docs-ref-autogen/word_desktop_1_2/word/word.window.yml index f2710eaa37..852feeabf6 100644 --- a/docs/docs-ref-autogen/word_desktop_1_2/word/word.window.yml +++ b/docs/docs-ref-autogen/word_desktop_1_2/word/word.window.yml @@ -44,15 +44,15 @@ remarks: >- 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); } @@ -115,7 +115,7 @@ properties: const pagesIndexes = []; for (let i = 0; i < pageCount; i++) { const page = pages.items[i]; - page.load('index'); + page.load("index"); pagesIndexes.push(page); } diff --git a/docs/docs-ref-autogen/word_desktop_1_2/word/word.windowcollection.yml b/docs/docs-ref-autogen/word_desktop_1_2/word/word.windowcollection.yml index 8b6fc3c423..34bbf9d9d7 100644 --- a/docs/docs-ref-autogen/word_desktop_1_2/word/word.windowcollection.yml +++ b/docs/docs-ref-autogen/word_desktop_1_2/word/word.windowcollection.yml @@ -8,6 +8,28 @@ remarks: >- \[ [API set: WordApiDesktop 1.2](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + #### Examples + + + ```TypeScript + + // 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}`); + }); + + ``` + isPreview: false isDeprecated: false type: class diff --git a/docs/docs-ref-autogen/word_desktop_1_3/word/word.document.yml b/docs/docs-ref-autogen/word_desktop_1_3/word/word.document.yml index 4d3f345a57..250ccdea76 100644 --- a/docs/docs-ref-autogen/word_desktop_1_3/word/word.document.yml +++ b/docs/docs-ref-autogen/word_desktop_1_3/word/word.document.yml @@ -86,15 +86,15 @@ properties: 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); } diff --git a/docs/docs-ref-autogen/word_desktop_1_3/word/word.page.yml b/docs/docs-ref-autogen/word_desktop_1_3/word/word.page.yml index 6dc5d1b679..c436cfe069 100644 --- a/docs/docs-ref-autogen/word_desktop_1_3/word/word.page.yml +++ b/docs/docs-ref-autogen/word_desktop_1_3/word/word.page.yml @@ -32,11 +32,11 @@ remarks: >- 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); } @@ -140,11 +140,11 @@ properties: 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); } @@ -254,11 +254,11 @@ methods: 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); } diff --git a/docs/docs-ref-autogen/word_desktop_1_3/word/word.pagecollection.yml b/docs/docs-ref-autogen/word_desktop_1_3/word/word.pagecollection.yml index bc2f8c8d44..aaa7e4c4b5 100644 --- a/docs/docs-ref-autogen/word_desktop_1_3/word/word.pagecollection.yml +++ b/docs/docs-ref-autogen/word_desktop_1_3/word/word.pagecollection.yml @@ -30,11 +30,11 @@ remarks: >- 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); } diff --git a/docs/docs-ref-autogen/word_desktop_1_3/word/word.pane.yml b/docs/docs-ref-autogen/word_desktop_1_3/word/word.pane.yml index eb1bb7a62a..b6a3d2346b 100644 --- a/docs/docs-ref-autogen/word_desktop_1_3/word/word.pane.yml +++ b/docs/docs-ref-autogen/word_desktop_1_3/word/word.pane.yml @@ -45,15 +45,15 @@ remarks: >- 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); } @@ -130,15 +130,15 @@ properties: 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); } @@ -205,7 +205,7 @@ properties: const pagesIndexes = []; for (let i = 0; i < pageCount; i++) { const page = pages.items[i]; - page.load('index'); + page.load("index"); pagesIndexes.push(page); } diff --git a/docs/docs-ref-autogen/word_desktop_1_3/word/word.panecollection.yml b/docs/docs-ref-autogen/word_desktop_1_3/word/word.panecollection.yml index a7f960cd96..81b92a396a 100644 --- a/docs/docs-ref-autogen/word_desktop_1_3/word/word.panecollection.yml +++ b/docs/docs-ref-autogen/word_desktop_1_3/word/word.panecollection.yml @@ -8,6 +8,31 @@ remarks: >- \[ [API set: WordApiDesktop 1.2](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + #### Examples + + + ```TypeScript + + // 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}`); + }); + + ``` + isPreview: false isDeprecated: false type: class diff --git a/docs/docs-ref-autogen/word_desktop_1_3/word/word.window.yml b/docs/docs-ref-autogen/word_desktop_1_3/word/word.window.yml index f2710eaa37..852feeabf6 100644 --- a/docs/docs-ref-autogen/word_desktop_1_3/word/word.window.yml +++ b/docs/docs-ref-autogen/word_desktop_1_3/word/word.window.yml @@ -44,15 +44,15 @@ remarks: >- 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); } @@ -115,7 +115,7 @@ properties: const pagesIndexes = []; for (let i = 0; i < pageCount; i++) { const page = pages.items[i]; - page.load('index'); + page.load("index"); pagesIndexes.push(page); } diff --git a/docs/docs-ref-autogen/word_desktop_1_3/word/word.windowcollection.yml b/docs/docs-ref-autogen/word_desktop_1_3/word/word.windowcollection.yml index 8b6fc3c423..34bbf9d9d7 100644 --- a/docs/docs-ref-autogen/word_desktop_1_3/word/word.windowcollection.yml +++ b/docs/docs-ref-autogen/word_desktop_1_3/word/word.windowcollection.yml @@ -8,6 +8,28 @@ remarks: >- \[ [API set: WordApiDesktop 1.2](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + #### Examples + + + ```TypeScript + + // 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}`); + }); + + ``` + isPreview: false isDeprecated: false type: class diff --git a/generate-docs/API Coverage Report.csv b/generate-docs/API Coverage Report.csv index 1a80c50650..f0489782e3 100644 --- a/generate-docs/API Coverage Report.csv +++ b/generate-docs/API Coverage Report.csv @@ -16059,7 +16059,7 @@ word,Word.Pane,"load(propertyNamesAndPaths)",Method,Excellent,false word,Word.Pane,"toJSON()",Method,Excellent,false word,Word.Pane,"track()",Method,Excellent,false word,Word.Pane,"untrack()",Method,Excellent,false -word,Word.PaneCollection,N/A,Class,Unknown,false +word,Word.PaneCollection,N/A,Class,Unknown,true word,Word.PaneCollection,"context",Property,Excellent,false word,Word.PaneCollection,"items",Property,Poor,false word,Word.PaneCollection,"getFirst()",Method,Great,false @@ -18958,7 +18958,7 @@ word,Word.Window,"untrack()",Method,Excellent,false word,Word.WindowCloseOptions,N/A,Interface,Unknown,false word,Word.WindowCloseOptions,"routeDocument",Property,Excellent,false word,Word.WindowCloseOptions,"saveChanges",Property,Excellent,false -word,Word.WindowCollection,N/A,Class,Unknown,false +word,Word.WindowCollection,N/A,Class,Unknown,true word,Word.WindowCollection,"context",Property,Excellent,false word,Word.WindowCollection,"items",Property,Poor,false word,Word.WindowCollection,"getFirst()",Method,Great,false diff --git a/generate-docs/script-inputs/script-lab-snippets.yaml b/generate-docs/script-inputs/script-lab-snippets.yaml index 33f3fdacd7..d95f506786 100644 --- a/generate-docs/script-inputs/script-lab-snippets.yaml +++ b/generate-docs/script-inputs/script-lab-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}`); + });