Edit

Share via

Word.BodyType enum

  • Reference
Package:
word

Represents the types of body objects.

Remarks

[ API set: WordApi 1.3 ]

Examples

// 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: Word.NoteItemCollection = context.document.body.footnotes;
  footnotes.load("items");
  await context.sync();

  const referenceNumber = $("#input-reference").val();
  const mark = (referenceNumber as number) - 1;
  const item: Word.NoteItem = 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}`);
});

Fields

endnote = "Endnote"

Endnote body.
footer = "Footer"

Footer body.
footnote = "Footnote"

Footnote body.
header = "Header"

Header body.
mainDoc = "MainDoc"

Main document body.
noteItem = "NoteItem"

Note body e.g., endnote, footnote.
section = "Section"

Section body.
shape = "Shape"

Shape body.
tableCell = "TableCell"

Table cell body.
unknown = "Unknown"

Unknown body type.