word.body.yml

### YamlMime:TSType
name: Word.Body
uid: 'word!Word.Body:class'
package: word!
fullName: Word.Body
summary: Represents the body of a document or a section.
remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
type: class
properties:
  - name: contentControls
    uid: 'word!Word.Body#contentControls:member'
    package: word!
    fullName: contentControls
    summary: Gets the collection of rich text content control objects in the body.
    remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'readonly contentControls: Word.ContentControlCollection;'
      return:
        type: '<xref uid="word!Word.ContentControlCollection:class" />'
  - name: context
    uid: 'word!Word.Body#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: false
    isDeprecated: false
    syntax:
      content: 'context: RequestContext;'
      return:
        type: '<xref uid="word!Word.RequestContext:class" />'
  - name: endnotes
    uid: 'word!Word.Body#endnotes:member'
    package: word!
    fullName: endnotes
    summary: Gets the collection of endnotes in the body.
    remarks: '\[ [API set: WordApi 1.5](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'readonly endnotes: Word.NoteItemCollection;'
      return:
        type: '<xref uid="word!Word.NoteItemCollection:class" />'
  - name: fields
    uid: 'word!Word.Body#fields:member'
    package: word!
    fullName: fields
    summary: Gets the collection of field objects in the body.
    remarks: >-
      \[ [API set: WordApi 1.4](/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/50-document/manage-fields.yaml


      // Gets all fields in the document body.

      await Word.run(async (context) => {
        const fields = context.document.body.fields.load("items");

        await context.sync();

        if (fields.items.length === 0) {
          console.log("No fields in this document.");
        } else {
          fields.load(["code", "result"]);
          await context.sync();

          for (let i = 0; i < fields.items.length; i++) {
            console.log(`Field ${i + 1}'s code: ${fields.items[i].code}`, `Field ${i + 1}'s result: ${JSON.stringify(fields.items[i].result)}`);
          }
        }
      });

      ```
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'readonly fields: Word.FieldCollection;'
      return:
        type: '<xref uid="word!Word.FieldCollection:class" />'
  - name: font
    uid: 'word!Word.Body#font:member'
    package: word!
    fullName: font
    summary: '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](/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/50-document/manage-body.yaml


      // Gets the style and the font size, font name, and font color properties on the body object.

      // Run a batch operation against the Word object model.

      await Word.run(async (context) => {
        // Create a proxy object for the document body.
        const body = context.document.body;

        // Queue a command to load font and style information for the document body.
        body.load("font/size, font/name, font/color, style");

        // Synchronize the document state by executing the queued commands, and return a promise to indicate task completion.
        await context.sync();

        // Show font-related property values on the body object.
        const results =
          "Font size: " +
          body.font.size +
          "; Font name: " +
          body.font.name +
          "; Font color: " +
          body.font.color +
          "; Body style: " +
          body.style;

        console.log(results);
      });

      ```
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'readonly font: Word.Font;'
      return:
        type: '<xref uid="word!Word.Font:class" />'
  - name: footnotes
    uid: 'word!Word.Body#footnotes:member'
    package: word!
    fullName: footnotes
    summary: Gets the collection of footnotes in the body.
    remarks: >-
      \[ [API set: WordApi 1.5](/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/50-document/manage-footnotes.yaml


      // Gets the footnotes in the document body.

      await Word.run(async (context) => {
        const footnotes = context.document.body.footnotes;
        footnotes.load("length");
        await context.sync();

        console.log("Number of footnotes in the document body: " + footnotes.items.length);
      });

      ```
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'readonly footnotes: Word.NoteItemCollection;'
      return:
        type: '<xref uid="word!Word.NoteItemCollection:class" />'
  - name: inlinePictures
    uid: 'word!Word.Body#inlinePictures:member'
    package: word!
    fullName: inlinePictures
    summary: Gets the collection of InlinePicture objects in the body. The collection doesn't include floating images.
    remarks: >-
      \[ [API set: WordApi 1.1](/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/15-images/insert-and-get-pictures.yaml


      // Gets the first image in the document.

      await Word.run(async (context) => {
        const firstPicture = context.document.body.inlinePictures.getFirst();
        firstPicture.load("width, height");

        await context.sync();
        console.log(`Image dimensions: ${firstPicture.width} x ${firstPicture.height}`);
        // Get the image encoded as Base64.
        const base64 = firstPicture.getBase64ImageSrc();

        await context.sync();
        console.log(base64.value);
      });

      ```
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'readonly inlinePictures: Word.InlinePictureCollection;'
      return:
        type: '<xref uid="word!Word.InlinePictureCollection:class" />'
  - name: lists
    uid: 'word!Word.Body#lists:member'
    package: word!
    fullName: lists
    summary: Gets the collection of list objects in the body.
    remarks: >-
      \[ [API set: WordApi 1.3](/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/20-lists/organize-list.yaml


      // Gets information about the first list in the document.

      await Word.run(async (context) => {
        const lists = context.document.body.lists;
        lists.load("items");

        await context.sync();

        if (lists.items.length === 0) {
          console.warn("There are no lists in this document.");
          return;
        }
        
        // Get the first list.
        const list = lists.getFirst();
        list.load("levelTypes,levelExistences");

        await context.sync();

        const levelTypes = list.levelTypes;
        console.log("Level types of the first list:");
        for (let i = 0; i < levelTypes.length; i++) {
          console.log(`- Level ${i + 1} (index ${i}): ${levelTypes[i]}`);
        }

        const levelExistences = list.levelExistences;
        console.log("Level existences of the first list:");
        for (let i = 0; i < levelExistences.length; i++) {
          console.log(`- Level ${i + 1} (index ${i}): ${levelExistences[i]}`);
        }
      });

      ```
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'readonly lists: Word.ListCollection;'
      return:
        type: '<xref uid="word!Word.ListCollection:class" />'
  - name: paragraphs
    uid: 'word!Word.Body#paragraphs:member'
    package: word!
    fullName: paragraphs
    summary: Gets the collection of paragraph objects in the body.
    remarks: >-
      \[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]


      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.


      #### Examples


      ```TypeScript

      // Link to full sample:
      https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/get-word-count.yaml


      // Counts how many times each term appears in the document.

      await Word.run(async (context) => {
        const paragraphs = context.document.body.paragraphs;
        paragraphs.load("text");
        await context.sync();

        // Split up the document text using existing spaces as the delimiter.
        let text = [];
        paragraphs.items.forEach((item) => {
          let paragraph = item.text.trim();
          if (paragraph) {
            paragraph.split(" ").forEach((term) => {
              let currentTerm = term.trim();
              if (currentTerm) {
                text.push(currentTerm);
              }
            });
          }
        });

        // Determine the list of unique terms.
        let makeTextDistinct = new Set(text);
        let distinctText = Array.from(makeTextDistinct);
        let allSearchResults = [];

        for (let i = 0; i < distinctText.length; i++) {
          let results = context.document.body.search(distinctText[i], { matchCase: true, matchWholeWord: true });
          results.load("text");

          // Map each search term with its results.
          let correlatedResults = {
            searchTerm: distinctText[i],
            hits: results
          };

          allSearchResults.push(correlatedResults);
        }

        await context.sync();

        // Display the count for each search term.
        allSearchResults.forEach((result) => {
          let length = result.hits.items.length;

          console.log("Search term: " + result.searchTerm + " => Count: " + length);
        });
      });

      ```
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'readonly paragraphs: Word.ParagraphCollection;'
      return:
        type: '<xref uid="word!Word.ParagraphCollection:class" />'
  - name: parentBody
    uid: 'word!Word.Body#parentBody:member'
    package: word!
    fullName: parentBody
    summary: >-
      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 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'readonly parentBody: Word.Body;'
      return:
        type: '<xref uid="word!Word.Body:class" />'
  - name: parentBodyOrNullObject
    uid: 'word!Word.Body#parentBodyOrNullObject:member'
    package: word!
    fullName: parentBodyOrNullObject
    summary: >-
      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 [*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: false
    isDeprecated: false
    syntax:
      content: 'readonly parentBodyOrNullObject: Word.Body;'
      return:
        type: '<xref uid="word!Word.Body:class" />'
  - name: parentContentControl
    uid: 'word!Word.Body#parentContentControl:member'
    package: word!
    fullName: parentContentControl
    summary: >-
      Gets the content control that contains the body. 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: false
    isDeprecated: false
    syntax:
      content: 'readonly parentContentControl: Word.ContentControl;'
      return:
        type: '<xref uid="word!Word.ContentControl:class" />'
  - name: parentContentControlOrNullObject
    uid: 'word!Word.Body#parentContentControlOrNullObject:member'
    package: word!
    fullName: parentContentControlOrNullObject
    summary: >-
      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
      [*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: false
    isDeprecated: false
    syntax:
      content: 'readonly parentContentControlOrNullObject: Word.ContentControl;'
      return:
        type: '<xref uid="word!Word.ContentControl:class" />'
  - name: parentSection
    uid: 'word!Word.Body#parentSection:member'
    package: word!
    fullName: parentSection
    summary: Gets the parent section of the body. Throws an `ItemNotFound` error if there isn't a parent section.
    remarks: '\[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'readonly parentSection: Word.Section;'
      return:
        type: '<xref uid="word!Word.Section:class" />'
  - name: parentSectionOrNullObject
    uid: 'word!Word.Body#parentSectionOrNullObject:member'
    package: word!
    fullName: parentSectionOrNullObject
    summary: >-
      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 [*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: false
    isDeprecated: false
    syntax:
      content: 'readonly parentSectionOrNullObject: Word.Section;'
      return:
        type: '<xref uid="word!Word.Section:class" />'
  - name: style
    uid: 'word!Word.Body#style:member'
    package: word!
    fullName: style
    summary: >-
      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](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'style: string;'
      return:
        type: string
  - name: styleBuiltIn
    uid: 'word!Word.Body#styleBuiltIn:member'
    package: word!
    fullName: styleBuiltIn
    summary: >-
      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](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: >-
        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";
      return:
        type: >-
          <xref uid="word!Word.BuiltInStyleName:enum" /> | "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"
  - name: tables
    uid: 'word!Word.Body#tables:member'
    package: word!
    fullName: tables
    summary: Gets the collection of table objects in the body.
    remarks: >-
      \[ [API set: WordApi 1.3](/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/40-tables/table-cell-access.yaml


      // Gets the content of the first cell in the first table.

      await Word.run(async (context) => {
        const firstCell = context.document.body.tables.getFirst().getCell(0, 0).body;
        firstCell.load("text");

        await context.sync();
        console.log("First cell's text is: " + firstCell.text);
      });

      ```
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'readonly tables: Word.TableCollection;'
      return:
        type: '<xref uid="word!Word.TableCollection:class" />'
  - name: text
    uid: 'word!Word.Body#text:member'
    package: word!
    fullName: text
    summary: Gets the text of the body. Use the insertText method to insert text.
    remarks: >-
      \[ [API set: WordApi 1.1](/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/50-document/manage-body.yaml


      // Gets the text content of the body.

      // Run a batch operation against the Word object model.

      await Word.run(async (context) => {
        // Create a proxy object for the document body.
        const body = context.document.body;

        // Queue a command to load the text in document body.
        body.load("text");

        // Synchronize the document state by executing the queued commands, and return a promise to indicate task completion.
        await context.sync();

        console.log("Body contents (text): " + body.text);
      });

      ```
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'readonly text: string;'
      return:
        type: string
  - name: type
    uid: 'word!Word.Body#type:member'
    package: word!
    fullName: type
    summary: >-
      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](/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/50-document/manage-footnotes.yaml


      // Gets the referenced note's item type and body type, which are both "Footnote".

      await Word.run(async (context) => {
        const footnotes = context.document.body.footnotes;
        footnotes.load("items");
        await context.sync();

        const referenceNumber = $("#input-reference").val();
        const mark = (referenceNumber as number) - 1;
        const item = footnotes.items[mark];
        console.log(`Note type of footnote ${referenceNumber}: ${item.type}`);

        item.body.load("type");
        await context.sync();

        console.log(`Body type of note: ${item.body.type}`);
      });

      ```
    isPreview: false
    isDeprecated: false
    syntax:
      content: >-
        readonly type: Word.BodyType | "Unknown" | "MainDoc" | "Section" | "Header" | "Footer" | "TableCell" |
        "Footnote" | "Endnote" | "NoteItem";
      return:
        type: >-
          <xref uid="word!Word.BodyType:enum" /> | "Unknown" | "MainDoc" | "Section" | "Header" | "Footer" | "TableCell"
          | "Footnote" | "Endnote" | "NoteItem"
methods:
  - name: clear()
    uid: 'word!Word.Body#clear:member(1)'
    package: word!
    fullName: clear()
    summary: Clears the contents of the body object. The user can perform the undo operation on the cleared content.
    remarks: >-
      \[ [API set: WordApi 1.1](/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/50-document/manage-body.yaml


      // Clears out the content from the document body.

      // Run a batch operation against the Word object model.

      await Word.run(async (context) => {
        // Create a proxy object for the document body.
        const body = context.document.body;

        // Queue a command to clear the contents of the body.
        body.clear();

        console.log("Cleared the body contents.");
      });


      // The Silly stories add-in sample shows how the clear method can be used to clear the contents of a document.

      // https://aka.ms/sillystorywordaddin

      ```
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'clear(): void;'
      return:
        type: void
        description: ''
  - name: getComments()
    uid: 'word!Word.Body#getComments:member(1)'
    package: word!
    fullName: getComments()
    summary: Gets comments associated with the body.
    remarks: >-
      \[ [API set: WordApi 1.4](/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/50-document/manage-comments.yaml


      // Gets the comments in the document body.

      await Word.run(async (context) => {
        const comments = context.document.body.getComments();

        // Load objects to log in the console.
        comments.load();
        await context.sync();

        console.log("All comments:", comments);
      });

      ```
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'getComments(): Word.CommentCollection;'
      return:
        type: '<xref uid="word!Word.CommentCollection:class" />'
        description: ''
  - name: getContentControls(options)
    uid: 'word!Word.Body#getContentControls:member(1)'
    package: word!
    fullName: getContentControls(options)
    summary: Gets the currently supported content controls in the body.
    remarks: >-
      \[ [API set: WordApi 1.5](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]


      Important: If specific types are provided in the options parameter, only content controls of supported types are
      returned. Be aware that an exception will be thrown on using methods of a generic
      [Word.ContentControl](xref:word!Word.ContentControl:class) that aren't relevant for the specific type. With time,
      additional types of content controls may be supported. Therefore, your add-in should request and handle specific
      types of content controls.
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection;'
      parameters:
        - id: options
          description: Optional. Options that define which content controls are returned.
          type: '<xref uid="word!Word.ContentControlOptions:interface" />'
      return:
        type: '<xref uid="word!Word.ContentControlCollection:class" />'
        description: ''
  - name: getHtml()
    uid: 'word!Word.Body#getHtml:member(1)'
    package: word!
    fullName: getHtml()
    summary: >-
      Gets an HTML representation of the body object. When rendered in a web page or HTML viewer, the formatting will be
      a close, but not exact, match for of the formatting of the document. This method doesn't return the exact same
      HTML for the same document on different platforms (Windows, Mac, Word on the web, etc.). If you need exact
      fidelity, or consistency across platforms, use `Body.getOoxml()` and convert the returned XML to HTML.
    remarks: >-
      \[ [API set: WordApi 1.1](/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/50-document/manage-body.yaml


      // Gets the HTML that represents the content of the body.

      // Run a batch operation against the Word object model.

      await Word.run(async (context) => {
        // Create a proxy object for the document body.
        const body = context.document.body;

        // Queue a command to get the HTML contents of the body.
        const bodyHTML = body.getHtml();

        // Synchronize the document state by executing the queued commands, and return a promise to indicate task completion.
        await context.sync();

        console.log("Body contents (HTML): " + bodyHTML.value);
      });

      ```
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'getHtml(): OfficeExtension.ClientResult<string>;'
      return:
        type: '<xref uid="office!OfficeExtension.ClientResult:class" />&lt;string&gt;'
        description: ''
  - name: getOoxml()
    uid: 'word!Word.Body#getOoxml:member(1)'
    package: word!
    fullName: getOoxml()
    summary: Gets the OOXML (Office Open XML) representation of the body object.
    remarks: >-
      \[ [API set: WordApi 1.1](/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/50-document/manage-body.yaml


      // Gets the OOXML that represents the content of the body.

      // Run a batch operation against the Word object model.

      await Word.run(async (context) => {
        // Create a proxy object for the document body.
        const body = context.document.body;

        // Queue a command to get the OOXML contents of the body.
        const bodyOOXML = body.getOoxml();

        // Synchronize the document state by executing the queued commands, and return a promise to indicate task completion.
        await context.sync();

        console.log("Body contents (OOXML): " + bodyOOXML.value);
      });

      ```
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'getOoxml(): OfficeExtension.ClientResult<string>;'
      return:
        type: '<xref uid="office!OfficeExtension.ClientResult:class" />&lt;string&gt;'
        description: ''
  - name: getRange(rangeLocation)
    uid: 'word!Word.Body#getRange:member(1)'
    package: word!
    fullName: getRange(rangeLocation)
    summary: 'Gets the whole body, or the starting or ending point of the body, as a range.'
    remarks: '\[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: >-
        getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end |
        Word.RangeLocation.after | Word.RangeLocation.content | "Whole" | "Start" | "End" | "After" | "Content"):
        Word.Range;
      parameters:
        - id: rangeLocation
          description: 'Optional. The range location must be ''Whole'', ''Start'', ''End'', ''After'', or ''Content''.'
          type: >-
            <xref uid="word!Word.RangeLocation.whole:member" /> | <xref uid="word!Word.RangeLocation.start:member" /> |
            <xref uid="word!Word.RangeLocation.end:member" /> | <xref uid="word!Word.RangeLocation.after:member" /> |
            <xref uid="word!Word.RangeLocation.content:member" /> | "Whole" | "Start" | "End" | "After" | "Content"
      return:
        type: '<xref uid="word!Word.Range:class" />'
        description: ''
  - name: getReviewedText(changeTrackingVersion)
    uid: 'word!Word.Body#getReviewedText:member(1)'
    package: word!
    fullName: getReviewedText(changeTrackingVersion)
    summary: Gets reviewed text based on ChangeTrackingVersion selection.
    remarks: '\[ [API set: WordApi 1.4](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion): OfficeExtension.ClientResult<string>;'
      parameters:
        - id: changeTrackingVersion
          description: Optional. The value must be 'Original' or 'Current'. The default is 'Current'.
          type: '<xref uid="word!Word.ChangeTrackingVersion:enum" />'
      return:
        type: '<xref uid="office!OfficeExtension.ClientResult:class" />&lt;string&gt;'
        description: ''
  - name: getReviewedText(changeTrackingVersionString)
    uid: 'word!Word.Body#getReviewedText:member(2)'
    package: word!
    fullName: getReviewedText(changeTrackingVersionString)
    summary: Gets reviewed text based on ChangeTrackingVersion selection.
    remarks: '\[ [API set: WordApi 1.4](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'getReviewedText(changeTrackingVersionString?: "Original" | "Current"): OfficeExtension.ClientResult<string>;'
      parameters:
        - id: changeTrackingVersionString
          description: Optional. The value must be 'Original' or 'Current'. The default is 'Current'.
          type: '"Original" | "Current"'
      return:
        type: '<xref uid="office!OfficeExtension.ClientResult:class" />&lt;string&gt;'
        description: ''
  - name: getTrackedChanges()
    uid: 'word!Word.Body#getTrackedChanges:member(1)'
    package: word!
    fullName: getTrackedChanges()
    summary: Gets the collection of the TrackedChange objects in the body.
    remarks: >-
      \[ [API set: WordApi 1.6](/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/50-document/manage-tracked-changes.yaml


      // Gets all tracked changes.

      await Word.run(async (context) => {
        const body = context.document.body;
        const trackedChanges = body.getTrackedChanges();
        trackedChanges.load();
        await context.sync();

        console.log(trackedChanges);
      });

      ```
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'getTrackedChanges(): Word.TrackedChangeCollection;'
      return:
        type: '<xref uid="word!Word.TrackedChangeCollection:class" />'
        description: ''
  - name: 'insertBreak(breakType, insertLocation)'
    uid: 'word!Word.Body#insertBreak:member(1)'
    package: word!
    fullName: 'insertBreak(breakType, insertLocation)'
    summary: Inserts a break at the specified location in the main document.
    remarks: >-
      \[ [API set: WordApi 1.1](/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/50-document/manage-body.yaml


      // Inserts a page break at the beginning of the document.

      // Run a batch operation against the Word object model.

      await Word.run(async (context) => {
        // Create a proxy object for the document body.
        const body = context.document.body;

        // Queue a command to insert a page break at the start of the document body.
        body.insertBreak(Word.BreakType.page, Word.InsertLocation.start);

        // Synchronize the document state by executing the queued commands, and return a promise to indicate task completion.
        await context.sync();

        console.log("Added a page break at the start of the document body.");
      });

      ```
    isPreview: false
    isDeprecated: false
    syntax:
      content: >-
        insertBreak(breakType: Word.BreakType | "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" |
        "SectionOdd" | "Line", insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | "Start" | "End"):
        void;
      parameters:
        - id: breakType
          description: Required. The break type to add to the body.
          type: >-
            <xref uid="word!Word.BreakType:enum" /> | "Page" | "Next" | "SectionNext" | "SectionContinuous" |
            "SectionEven" | "SectionOdd" | "Line"
        - id: insertLocation
          description: Required. The value must be 'Start' or 'End'.
          type: >-
            <xref uid="word!Word.InsertLocation.start:member" /> | <xref uid="word!Word.InsertLocation.end:member" /> |
            "Start" | "End"
      return:
        type: void
        description: ''
  - name: insertContentControl(contentControlType)
    uid: 'word!Word.Body#insertContentControl:member(1)'
    package: word!
    fullName: insertContentControl(contentControlType)
    summary: Wraps the Body object with a content control.
    remarks: >-
      \[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]


      Note: The `contentControlType` parameter was introduced in WordApi 1.5. `PlainText` support was added in WordApi
      1.5. `CheckBox` support was added in WordApi 1.7.


      #### Examples


      ```TypeScript

      // Link to full sample:
      https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-body.yaml


      // Creates a content control using the document body.

      // Run a batch operation against the Word object model.

      await Word.run(async (context) => {
        // Create a proxy object for the document body.
        const body = context.document.body;

        // Queue a command to wrap the body in a content control.
        body.insertContentControl();

        // Synchronize the document state by executing the queued commands, and return a promise to indicate task completion.
        await context.sync();

        console.log("Wrapped the body in a content control.");
      });

      ```
    isPreview: false
    isDeprecated: false
    syntax:
      content: >-
        insertContentControl(contentControlType?: Word.ContentControlType.richText | Word.ContentControlType.plainText |
        Word.ContentControlType.checkBox | "RichText" | "PlainText" | "CheckBox"): Word.ContentControl;
      parameters:
        - id: contentControlType
          description: >-
            Optional. Content control type to insert. Must be 'RichText', 'PlainText', or 'CheckBox'. The default is
            'RichText'.
          type: >-
            <xref uid="word!Word.ContentControlType.richText:member" /> | <xref
            uid="word!Word.ContentControlType.plainText:member" /> | <xref
            uid="word!Word.ContentControlType.checkBox:member" /> | "RichText" | "PlainText" | "CheckBox"
      return:
        type: '<xref uid="word!Word.ContentControl:class" />'
        description: ''
  - name: 'insertFileFromBase64(base64File, insertLocation)'
    uid: 'word!Word.Body#insertFileFromBase64:member(1)'
    package: word!
    fullName: 'insertFileFromBase64(base64File, insertLocation)'
    summary: Inserts a document into the body at the specified location.
    remarks: >-
      \[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]


      Note: Insertion isn't supported if the document being inserted contains an ActiveX control (likely in a form
      field). Consider replacing such a form field with a content control or other option appropriate for your scenario.


      #### Examples


      ```TypeScript

      // Link to full sample:
      https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-body.yaml


      // Inserts the body from the external document at the beginning of this document.

      // Run a batch operation against the Word object model.

      await Word.run(async (context) => {
        // Create a proxy object for the document body.
        const body = context.document.body;

        // Queue a command to insert the Base64-encoded string representation of the body of the selected .docx file at the beginning of the current document.
        body.insertFileFromBase64(externalDocument, Word.InsertLocation.start);

        // Synchronize the document state by executing the queued commands, and return a promise to indicate task completion.
        await context.sync();

        console.log("Added Base64-encoded text to the beginning of the document body.");
      });

      ```
    isPreview: false
    isDeprecated: false
    syntax:
      content: >-
        insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start
        | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;
      parameters:
        - id: base64File
          description: Required. The Base64-encoded content of a .docx file.
          type: string
        - id: insertLocation
          description: 'Required. The value must be ''Replace'', ''Start'', or ''End''.'
          type: >-
            <xref uid="word!Word.InsertLocation.replace:member" /> | <xref uid="word!Word.InsertLocation.start:member"
            /> | <xref uid="word!Word.InsertLocation.end:member" /> | "Replace" | "Start" | "End"
      return:
        type: '<xref uid="word!Word.Range:class" />'
        description: ''
  - name: 'insertHtml(html, insertLocation)'
    uid: 'word!Word.Body#insertHtml:member(1)'
    package: word!
    fullName: 'insertHtml(html, insertLocation)'
    summary: Inserts HTML at the specified location.
    remarks: >-
      \[ [API set: WordApi 1.1](/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/50-document/manage-body.yaml


      // Inserts the HTML at the beginning of this document.

      // Run a batch operation against the Word object model.

      await Word.run(async (context) => {
        // Create a proxy object for the document body.
        const body = context.document.body;

        // Queue a command to insert HTML at the beginning of the document.
        body.insertHtml("<strong>This is text inserted with body.insertHtml()</strong>", Word.InsertLocation.start);

        // Synchronize the document state by executing the queued commands, and return a promise to indicate task completion.
        await context.sync();

        console.log("HTML added to the beginning of the document body.");
      });

      ```
    isPreview: false
    isDeprecated: false
    syntax:
      content: >-
        insertHtml(html: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start |
        Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;
      parameters:
        - id: html
          description: Required. The HTML to be inserted in the document.
          type: string
        - id: insertLocation
          description: 'Required. The value must be ''Replace'', ''Start'', or ''End''.'
          type: >-
            <xref uid="word!Word.InsertLocation.replace:member" /> | <xref uid="word!Word.InsertLocation.start:member"
            /> | <xref uid="word!Word.InsertLocation.end:member" /> | "Replace" | "Start" | "End"
      return:
        type: '<xref uid="word!Word.Range:class" />'
        description: ''
  - name: 'insertInlinePictureFromBase64(base64EncodedImage, insertLocation)'
    uid: 'word!Word.Body#insertInlinePictureFromBase64:member(1)'
    package: word!
    fullName: 'insertInlinePictureFromBase64(base64EncodedImage, insertLocation)'
    summary: Inserts a picture into the body at the specified location.
    remarks: >-
      \[ [API set: WordApi 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/50-document/manage-body.yaml


      // Inserts an image inline at the beginning of this document.

      // Run a batch operation against the Word object model.

      await Word.run(async (context) => {
        // Create a proxy object for the document body.
        const body = context.document.body;

        // Base64-encoded image to insert inline.
        const base64EncodedImg =
          "iVBORw0KGgoAAAANSUhEUgAAAB4AAAANCAIAAAAxEEnAAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAACFSURBVDhPtY1BEoQwDMP6/0+XgIMTBAeYoTqso9Rkx1zG+tNj1H94jgGzeNSjteO5vtQQuG2seO0av8LzGbe3anzRoJ4ybm/VeKEerAEbAUpW4aWQCmrGFWykRzGBCnYy2ha3oAIq2MloW9yCCqhgJ6NtcQsqoIKdjLbFLaiACnYyf2fODbrjZcXfr2F4AAAAAElFTkSuQmCC";

        // Queue a command to insert a Base64-encoded image at the beginning of the current document.
        body.insertInlinePictureFromBase64(base64EncodedImg, Word.InsertLocation.start);

        // Synchronize the document state by executing the queued commands, and return a promise to indicate task completion.
        await context.sync();

        console.log("Added a Base64-encoded image to the beginning of the document body.");
      });

      ```
    isPreview: false
    isDeprecated: false
    syntax:
      content: >-
        insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.start |
        Word.InsertLocation.end | "Start" | "End"): Word.InlinePicture;
      parameters:
        - id: base64EncodedImage
          description: Required. The Base64-encoded image to be inserted in the body.
          type: string
        - id: insertLocation
          description: Required. The value must be 'Start' or 'End'.
          type: >-
            <xref uid="word!Word.InsertLocation.start:member" /> | <xref uid="word!Word.InsertLocation.end:member" /> |
            "Start" | "End"
      return:
        type: '<xref uid="word!Word.InlinePicture:class" />'
        description: ''
  - name: 'insertOoxml(ooxml, insertLocation)'
    uid: 'word!Word.Body#insertOoxml:member(1)'
    package: word!
    fullName: 'insertOoxml(ooxml, insertLocation)'
    summary: Inserts OOXML at the specified location.
    remarks: >-
      \[ [API set: WordApi 1.1](/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/50-document/manage-body.yaml


      // Inserts OOXML at the beginning of this document.

      // Run a batch operation against the Word object model.

      await Word.run(async (context) => {
        // Create a proxy object for the document body.
        const body = context.document.body;

        // Queue a command to insert OOXML at the beginning of the body.
        body.insertOoxml(
          "<pkg:package xmlns:pkg='http://schemas.microsoft.com/office/2006/xmlPackage'><pkg:part pkg:name='/_rels/.rels' pkg:contentType='application/vnd.openxmlformats-package.relationships+xml' pkg:padding='512'><pkg:xmlData><Relationships xmlns='http://schemas.openxmlformats.org/package/2006/relationships'><Relationship Id='rId1' Type='http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument' Target='word/document.xml'/></Relationships></pkg:xmlData></pkg:part><pkg:part pkg:name='/word/document.xml' pkg:contentType='application/vnd.openxmlformats-officedocument.wordprocessingml.document.main+xml'><pkg:xmlData><w:document xmlns:w='http://schemas.openxmlformats.org/wordprocessingml/2006/main' ><w:body><w:p><w:pPr><w:spacing w:before='360' w:after='0' w:line='480' w:lineRule='auto'/><w:rPr><w:color w:val='70AD47' w:themeColor='accent6'/><w:sz w:val='28'/></w:rPr></w:pPr><w:r><w:rPr><w:color w:val='70AD47' w:themeColor='accent6'/><w:sz w:val='28'/></w:rPr><w:t>This text has formatting directly applied to achieve its font size, color, line spacing, and paragraph spacing.</w:t></w:r></w:p></w:body></w:document></pkg:xmlData></pkg:part></pkg:package>",
          Word.InsertLocation.start
        );

        // Synchronize the document state by executing the queued commands, and return a promise to indicate task completion.
        await context.sync();

        console.log("Added OOXML to the beginning of the document body.");
      });


      // Read "Understand when and how to use Office Open XML in your Word add-in" for guidance on working with OOXML.

      // https://learn.microsoft.com/office/dev/add-ins/word/create-better-add-ins-for-word-with-office-open-xml


      // The Word-Add-in-DocumentAssembly sample shows how you can use this API to assemble a document.

      // https://github.com/OfficeDev/Word-Add-in-DocumentAssembly

      ```
    isPreview: false
    isDeprecated: false
    syntax:
      content: >-
        insertOoxml(ooxml: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start |
        Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;
      parameters:
        - id: ooxml
          description: Required. The OOXML to be inserted.
          type: string
        - id: insertLocation
          description: 'Required. The value must be ''Replace'', ''Start'', or ''End''.'
          type: >-
            <xref uid="word!Word.InsertLocation.replace:member" /> | <xref uid="word!Word.InsertLocation.start:member"
            /> | <xref uid="word!Word.InsertLocation.end:member" /> | "Replace" | "Start" | "End"
      return:
        type: '<xref uid="word!Word.Range:class" />'
        description: ''
  - name: 'insertParagraph(paragraphText, insertLocation)'
    uid: 'word!Word.Body#insertParagraph:member(1)'
    package: word!
    fullName: 'insertParagraph(paragraphText, insertLocation)'
    summary: Inserts a paragraph at the specified location.
    remarks: >-
      \[ [API set: WordApi 1.1](/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/25-paragraph/insert-formatted-text.yaml


      await Word.run(async (context) => {
        // Second sentence, let's insert it as a paragraph after the previously inserted one.
        const secondSentence = context.document.body.insertParagraph(
          "This is the first text with a custom style.",
          "End"
        );
        secondSentence.font.set({
          bold: false,
          italic: true,
          name: "Berlin Sans FB",
          color: "blue",
          size: 30
        });

        await context.sync();
      });

      ```
    isPreview: false
    isDeprecated: false
    syntax:
      content: >-
        insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.start | Word.InsertLocation.end |
        "Start" | "End"): Word.Paragraph;
      parameters:
        - id: paragraphText
          description: Required. The paragraph text to be inserted.
          type: string
        - id: insertLocation
          description: Required. The value must be 'Start' or 'End'.
          type: >-
            <xref uid="word!Word.InsertLocation.start:member" /> | <xref uid="word!Word.InsertLocation.end:member" /> |
            "Start" | "End"
      return:
        type: '<xref uid="word!Word.Paragraph:class" />'
        description: ''
  - name: 'insertTable(rowCount, columnCount, insertLocation, values)'
    uid: 'word!Word.Body#insertTable:member(1)'
    package: word!
    fullName: 'insertTable(rowCount, columnCount, insertLocation, values)'
    summary: Inserts a table with the specified number of rows and columns.
    remarks: >-
      \[ [API set: WordApi 1.3](/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/40-tables/table-cell-access.yaml


      await Word.run(async (context) => {
        // Use a two-dimensional array to hold the initial table values.
        const data = [
          ["Tokyo", "Beijing", "Seattle"],
          ["Apple", "Orange", "Pineapple"]
        ];
        const table = context.document.body.insertTable(2, 3, "Start", data);
        table.styleBuiltIn = Word.BuiltInStyleName.gridTable5Dark_Accent2;
        table.styleFirstColumn = false;

        await context.sync();
      });

      ```
    isPreview: false
    isDeprecated: false
    syntax:
      content: >-
        insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.start |
        Word.InsertLocation.end | "Start" | "End", values?: string[][]): Word.Table;
      parameters:
        - id: rowCount
          description: Required. The number of rows in the table.
          type: number
        - id: columnCount
          description: Required. The number of columns in the table.
          type: number
        - id: insertLocation
          description: Required. The value must be 'Start' or 'End'.
          type: >-
            <xref uid="word!Word.InsertLocation.start:member" /> | <xref uid="word!Word.InsertLocation.end:member" /> |
            "Start" | "End"
        - id: values
          description: Optional 2D array. Cells are filled if the corresponding strings are specified in the array.
          type: 'string[][]'
      return:
        type: '<xref uid="word!Word.Table:class" />'
        description: ''
  - name: 'insertText(text, insertLocation)'
    uid: 'word!Word.Body#insertText:member(1)'
    package: word!
    fullName: 'insertText(text, insertLocation)'
    summary: Inserts text into the body at the specified location.
    remarks: >-
      \[ [API set: WordApi 1.1](/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/50-document/manage-body.yaml


      // Inserts text at the beginning of this document.

      // Run a batch operation against the Word object model.

      await Word.run(async (context) => {
        // Create a proxy object for the document body.
        const body = context.document.body;

        // Queue a command to insert text at the beginning of the current document.
        body.insertText('This is text inserted with body.insertText()', Word.InsertLocation.start);

        // Synchronize the document state by executing the queued commands, and return a promise to indicate task completion.
        await context.sync();

        console.log("Text added to the beginning of the document body.");
      });

      ```
    isPreview: false
    isDeprecated: false
    syntax:
      content: >-
        insertText(text: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start |
        Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;
      parameters:
        - id: text
          description: Required. Text to be inserted.
          type: string
        - id: insertLocation
          description: 'Required. The value must be ''Replace'', ''Start'', or ''End''.'
          type: >-
            <xref uid="word!Word.InsertLocation.replace:member" /> | <xref uid="word!Word.InsertLocation.start:member"
            /> | <xref uid="word!Word.InsertLocation.end:member" /> | "Replace" | "Start" | "End"
      return:
        type: '<xref uid="word!Word.Range:class" />'
        description: ''
  - name: load(options)
    uid: 'word!Word.Body#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.BodyLoadOptions): Word.Body;'
      parameters:
        - id: options
          description: Provides options for which properties of the object to load.
          type: '<xref uid="word!Word.Interfaces.BodyLoadOptions:interface" />'
      return:
        type: '<xref uid="word!Word.Body:class" />'
        description: ''
  - name: load(propertyNames)
    uid: 'word!Word.Body#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: false
    isDeprecated: false
    syntax:
      content: 'load(propertyNames?: string | string[]): Word.Body;'
      parameters:
        - id: propertyNames
          description: A comma-delimited string or an array of strings that specify the properties to load.
          type: 'string | string[]'
      return:
        type: '<xref uid="word!Word.Body:class" />'
        description: ''
  - name: load(propertyNamesAndPaths)
    uid: 'word!Word.Body#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: false
    isDeprecated: false
    syntax:
      content: |-
        load(propertyNamesAndPaths?: {
                    select?: string;
                    expand?: string;
                }): Word.Body;
      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: '<xref uid="word!Word.Body:class" />'
        description: ''
  - name: 'search(searchText, searchOptions)'
    uid: 'word!Word.Body#search:member(1)'
    package: word!
    fullName: 'search(searchText, searchOptions)'
    summary: >-
      Performs a search with the specified SearchOptions on the scope of the body object. The search results are a
      collection of range objects.
    remarks: >-
      \[ [API set: WordApi 1.1](/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/25-paragraph/search.yaml


      // Does a basic text search and highlights matches in the document.

      await Word.run(async (context) => {
        const results : Word.RangeCollection = context.document.body.search("Online");
        results.load("length");

        await context.sync();

        // Let's traverse the search results and highlight matches.
        for (let i = 0; i < results.items.length; i++) {
          results.items[i].font.highlightColor = "yellow";
        }

        await context.sync();
      });


      ...


      // Does a wildcard search and highlights matches in the document.

      await Word.run(async (context) => {
        // Construct a wildcard expression and set matchWildcards to true in order to use wildcards.
        const results : Word.RangeCollection = context.document.body.search("$*.[0-9][0-9]", { matchWildcards: true });
        results.load("length");

        await context.sync();

        // Let's traverse the search results and highlight matches.
        for (let i = 0; i < results.items.length; i++) {
          results.items[i].font.highlightColor = "red";
          results.items[i].font.color = "white";
        }

        await context.sync();
      });

      ```
    isPreview: false
    isDeprecated: false
    syntax:
      content: |-
        search(searchText: string, searchOptions?: Word.SearchOptions | {
                    ignorePunct?: boolean;
                    ignoreSpace?: boolean;
                    matchCase?: boolean;
                    matchPrefix?: boolean;
                    matchSuffix?: boolean;
                    matchWholeWord?: boolean;
                    matchWildcards?: boolean;
                }): Word.RangeCollection;
      parameters:
        - id: searchText
          description: Required. The search text. Can be a maximum of 255 characters.
          type: string
        - id: searchOptions
          description: Optional. Options for the search.
          type: |-
            <xref uid="word!Word.SearchOptions:class" /> | {
                        ignorePunct?: boolean;
                        ignoreSpace?: boolean;
                        matchCase?: boolean;
                        matchPrefix?: boolean;
                        matchSuffix?: boolean;
                        matchWholeWord?: boolean;
                        matchWildcards?: boolean;
                    }
      return:
        type: '<xref uid="word!Word.RangeCollection:class" />'
        description: ''
  - name: select(selectionMode)
    uid: 'word!Word.Body#select:member(1)'
    package: word!
    fullName: select(selectionMode)
    summary: Selects the body and navigates the Word UI to it.
    remarks: >-
      \[ [API set: WordApi 1.1](/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/50-document/manage-body.yaml


      // Selects the entire body.

      // Run a batch operation against the Word object model.

      await Word.run(async (context) => {
        // Create a proxy object for the document body.
        const body = context.document.body;

        // Queue a command to select the document body.
        // The Word UI will move to the selected document body.
        body.select();

        console.log("Selected the document body.");
      });

      ```
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'select(selectionMode?: Word.SelectionMode): void;'
      parameters:
        - id: selectionMode
          description: 'Optional. The selection mode must be ''Select'', ''Start'', or ''End''. ''Select'' is the default.'
          type: '<xref uid="word!Word.SelectionMode:enum" />'
      return:
        type: void
        description: ''
  - name: select(selectionModeString)
    uid: 'word!Word.Body#select:member(2)'
    package: word!
    fullName: select(selectionModeString)
    summary: Selects the body and navigates the Word UI to it.
    remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'select(selectionModeString?: "Select" | "Start" | "End"): void;'
      parameters:
        - id: selectionModeString
          description: 'Optional. The selection mode must be ''Select'', ''Start'', or ''End''. ''Select'' is the default.'
          type: '"Select" | "Start" | "End"'
      return:
        type: void
        description: ''
  - name: 'set(properties, options)'
    uid: 'word!Word.Body#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: false
    isDeprecated: false
    syntax:
      content: 'set(properties: Interfaces.BodyUpdateData, 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: '<xref uid="word!Word.Interfaces.BodyUpdateData:interface" />'
        - id: options
          description: Provides an option to suppress errors if the properties object tries to set any read-only properties.
          type: '<xref uid="office!OfficeExtension.UpdateOptions:interface" />'
      return:
        type: void
        description: ''
  - name: set(properties)
    uid: 'word!Word.Body#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: false
    isDeprecated: false
    syntax:
      content: 'set(properties: Word.Body): void;'
      parameters:
        - id: properties
          description: ''
          type: '<xref uid="word!Word.Body:class" />'
      return:
        type: void
        description: ''
  - name: toJSON()
    uid: 'word!Word.Body#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 is
      passed to it.) Whereas the original Word.Body object is an API object, the `toJSON` method returns a plain
      JavaScript object (typed as `Word.Interfaces.BodyData`<!-- -->) that contains shallow copies of any loaded child
      properties from the original object.
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'toJSON(): Word.Interfaces.BodyData;'
      return:
        type: '<xref uid="word!Word.Interfaces.BodyData:interface" />'
        description: ''
  - name: track()
    uid: 'word!Word.Body#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: false
    isDeprecated: false
    syntax:
      content: 'track(): Word.Body;'
      return:
        type: '<xref uid="word!Word.Body:class" />'
        description: ''
  - name: untrack()
    uid: 'word!Word.Body#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: false
    isDeprecated: false
    syntax:
      content: 'untrack(): Word.Body;'
      return:
        type: '<xref uid="word!Word.Body:class" />'
        description: ''
events:
  - name: onCommentAdded
    uid: 'word!Word.Body#onCommentAdded:member'
    package: word!
    fullName: onCommentAdded
    summary: Occurs when new comments are added.
    remarks: >-
      \[ [API set: WordApi BETA (PREVIEW ONLY)](/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/99-preview-apis/manage-comments.yaml


      // Registers event handlers.

      await Word.run(async (context) => {
        const body = context.document.body;
        body.track();
        await context.sync();

        eventContexts[0] = body.onCommentAdded.add(onEventHandler);
        eventContexts[1] = body.onCommentChanged.add(onChangedHandler);
        eventContexts[2] = body.onCommentDeleted.add(onEventHandler);
        eventContexts[3] = body.onCommentDeselected.add(onEventHandler);
        eventContexts[4] = body.onCommentSelected.add(onEventHandler);
        await context.sync();

        console.log("Event handlers registered.");
      });


      ...


      async function onEventHandler(event: Word.CommentEventArgs) {
        // Handler for all events except onCommentChanged.
        await Word.run(async (context) => {
          console.log(`${event.type} event detected. Event source: ${event.source}. Comment info:`, event.commentDetails);
        });
      }

      ```
    isPreview: true
    isDeprecated: false
    syntax:
      content: 'readonly onCommentAdded: OfficeExtension.EventHandlers<Word.CommentEventArgs>;'
      return:
        type: >-
          <xref uid="office!OfficeExtension.EventHandlers:class" />&lt;<xref uid="word!Word.CommentEventArgs:interface"
          />&gt;
  - name: onCommentChanged
    uid: 'word!Word.Body#onCommentChanged:member'
    package: word!
    fullName: onCommentChanged
    summary: Occurs when a comment or its reply is changed.
    remarks: >-
      \[ [API set: WordApi BETA (PREVIEW ONLY)](/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/99-preview-apis/manage-comments.yaml


      // Registers event handlers.

      await Word.run(async (context) => {
        const body = context.document.body;
        body.track();
        await context.sync();

        eventContexts[0] = body.onCommentAdded.add(onEventHandler);
        eventContexts[1] = body.onCommentChanged.add(onChangedHandler);
        eventContexts[2] = body.onCommentDeleted.add(onEventHandler);
        eventContexts[3] = body.onCommentDeselected.add(onEventHandler);
        eventContexts[4] = body.onCommentSelected.add(onEventHandler);
        await context.sync();

        console.log("Event handlers registered.");
      });


      ...


      async function onChangedHandler(event: Word.CommentEventArgs) {
        await Word.run(async (context) => {
          console.log(
            `${event.type} event detected. ${event.changeType} change made. Event source: ${event.source}. Comment info:`, event.commentDetails
          );
        });
      }

      ```
    isPreview: true
    isDeprecated: false
    syntax:
      content: 'readonly onCommentChanged: OfficeExtension.EventHandlers<Word.CommentEventArgs>;'
      return:
        type: >-
          <xref uid="office!OfficeExtension.EventHandlers:class" />&lt;<xref uid="word!Word.CommentEventArgs:interface"
          />&gt;
  - name: onCommentDeleted
    uid: 'word!Word.Body#onCommentDeleted:member'
    package: word!
    fullName: onCommentDeleted
    summary: Occurs when comments are deleted.
    remarks: >-
      \[ [API set: WordApi BETA (PREVIEW ONLY)](/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/99-preview-apis/manage-comments.yaml


      // Registers event handlers.

      await Word.run(async (context) => {
        const body = context.document.body;
        body.track();
        await context.sync();

        eventContexts[0] = body.onCommentAdded.add(onEventHandler);
        eventContexts[1] = body.onCommentChanged.add(onChangedHandler);
        eventContexts[2] = body.onCommentDeleted.add(onEventHandler);
        eventContexts[3] = body.onCommentDeselected.add(onEventHandler);
        eventContexts[4] = body.onCommentSelected.add(onEventHandler);
        await context.sync();

        console.log("Event handlers registered.");
      });


      ...


      async function onEventHandler(event: Word.CommentEventArgs) {
        // Handler for all events except onCommentChanged.
        await Word.run(async (context) => {
          console.log(`${event.type} event detected. Event source: ${event.source}. Comment info:`, event.commentDetails);
        });
      }

      ```
    isPreview: true
    isDeprecated: false
    syntax:
      content: 'readonly onCommentDeleted: OfficeExtension.EventHandlers<Word.CommentEventArgs>;'
      return:
        type: >-
          <xref uid="office!OfficeExtension.EventHandlers:class" />&lt;<xref uid="word!Word.CommentEventArgs:interface"
          />&gt;
  - name: onCommentDeselected
    uid: 'word!Word.Body#onCommentDeselected:member'
    package: word!
    fullName: onCommentDeselected
    summary: Occurs when a comment is deselected.
    remarks: >-
      \[ [API set: WordApi BETA (PREVIEW ONLY)](/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/99-preview-apis/manage-comments.yaml


      // Registers event handlers.

      await Word.run(async (context) => {
        const body = context.document.body;
        body.track();
        await context.sync();

        eventContexts[0] = body.onCommentAdded.add(onEventHandler);
        eventContexts[1] = body.onCommentChanged.add(onChangedHandler);
        eventContexts[2] = body.onCommentDeleted.add(onEventHandler);
        eventContexts[3] = body.onCommentDeselected.add(onEventHandler);
        eventContexts[4] = body.onCommentSelected.add(onEventHandler);
        await context.sync();

        console.log("Event handlers registered.");
      });


      ...


      async function onEventHandler(event: Word.CommentEventArgs) {
        // Handler for all events except onCommentChanged.
        await Word.run(async (context) => {
          console.log(`${event.type} event detected. Event source: ${event.source}. Comment info:`, event.commentDetails);
        });
      }

      ```
    isPreview: true
    isDeprecated: false
    syntax:
      content: 'readonly onCommentDeselected: OfficeExtension.EventHandlers<Word.CommentEventArgs>;'
      return:
        type: >-
          <xref uid="office!OfficeExtension.EventHandlers:class" />&lt;<xref uid="word!Word.CommentEventArgs:interface"
          />&gt;
  - name: onCommentSelected
    uid: 'word!Word.Body#onCommentSelected:member'
    package: word!
    fullName: onCommentSelected
    summary: Occurs when a comment is selected.
    remarks: >-
      \[ [API set: WordApi BETA (PREVIEW ONLY)](/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/99-preview-apis/manage-comments.yaml


      // Registers event handlers.

      await Word.run(async (context) => {
        const body = context.document.body;
        body.track();
        await context.sync();

        eventContexts[0] = body.onCommentAdded.add(onEventHandler);
        eventContexts[1] = body.onCommentChanged.add(onChangedHandler);
        eventContexts[2] = body.onCommentDeleted.add(onEventHandler);
        eventContexts[3] = body.onCommentDeselected.add(onEventHandler);
        eventContexts[4] = body.onCommentSelected.add(onEventHandler);
        await context.sync();

        console.log("Event handlers registered.");
      });


      ...


      async function onEventHandler(event: Word.CommentEventArgs) {
        // Handler for all events except onCommentChanged.
        await Word.run(async (context) => {
          console.log(`${event.type} event detected. Event source: ${event.source}. Comment info:`, event.commentDetails);
        });
      }

      ```
    isPreview: true
    isDeprecated: false
    syntax:
      content: 'readonly onCommentSelected: OfficeExtension.EventHandlers<Word.CommentEventArgs>;'
      return:
        type: >-
          <xref uid="office!OfficeExtension.EventHandlers:class" />&lt;<xref uid="word!Word.CommentEventArgs:interface"
          />&gt;
extends: '<xref uid="office!OfficeExtension.ClientObject:class" />'