Automatically generated docs

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);
         }
 

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);
         }
 

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);
     }
 

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);
         }
 

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

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);
         }
 

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

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);
         }
 

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);
         }
 

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);
     }
 

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);
         }
 

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

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);
         }