Skip to main content

Word.List

Word.List is an object type of the Word module (Office.word(iframe)). 2 methods.

Generated from the SDK type definitions

Word · 14 object types · 259 methods · namespace Word. This reference is generated from the API document artifact (sdk-api-doc.html) produced with the SDK build. Descriptions are the editor's API comments as published. Pin the SDK and Office versions together and regenerate when either changes.

Remarks​

  • Module: Word · Office.word(iframe) · namespace Word
  • Obtained from: Paragraph.getList()
  • Every method returns a Promise; signatures use TypeScript notation.

Methods​

MethodDescription
restartNumbering()Restarts numbering from this paragraph.
setLevel(value)Changes the list level of this paragraph.

Method details​

restartNumbering()​

Restarts numbering from this paragraph.

restartNumbering(): Promise<void>;

Returns

Promise<void>

setLevel(value)​

Changes the list level of this paragraph.
Moves one level at a time with IndentType, or sets the target level with a 0-based number.
Even on the first item of the list, only this paragraph's level changes. The change can be undone in one step.
If the given level is deeper than the list supports, moves to the last level of that list.
To remove the list, use clearList() on the paragraph or range.

setLevel(value: IndentType | number): Promise<void>;

Parameters

NameTypeDescription
valueIndentType | number"indent" (one level in) | "outdent" (one level out) | target level (integer 0~8)

Returns

Promise<void>