Skip to main content

ListFormat

The numbering of the paragraphs a Range covers; minted by Range.listFormat. Import from @reductoai/docx/node, @reductoai/docx/officejs.

ListFormat properties

ListFormat.applyBulletDefault()

Put every covered paragraph on a FRESH bulleted list at level 1.

ListFormat.applyNumberDefault()

Put every covered paragraph on a FRESH decimal list at level 1.

ListFormat.applyOutlineNumberDefault()

Put every covered paragraph on a FRESH multi-level decimal outline — “1.”, “1.1.”, “1.1.1.” through all nine levels — all at level 1. Use listIndent to move an item down the outline.

ListFormat.countNumberedItems()

List paragraphs of the range; options.level narrows to ONE 1-based level.

ListFormat.listIndent()

Move every list paragraph of the range one level DOWN, clamped at level 9.

ListFormat.listOutdent()

Move every list paragraph of the range one level UP, clamped at level 1.

ListFormat.removeNumbers()

Clear w:numPr on every covered paragraph, keeping its text.

ListFormat.set()

Not implemented. These Office.js members throw: isSingleListTemplate, applyListTemplateWithLevel, canContinuePreviousList, convertNumbersToText.

ListItem

OfficeJS-shaped list metadata for a paragraph. Import from @reductoai/docx/node, @reductoai/docx/officejs.

ListItem properties

ListItem.getAncestor()

The nearest lower-level item, or the exact parent when parentOnly is true.

ListItem.getAncestorOrNullObject()

ListItem.getDescendants()

Descendant items in document order, optionally restricted to direct children.

ListItem.set()

ListLevel

One level of a list’s numbering definition. Import from @reductoai/docx/officejs.

ListLevel properties

ListLevel.set()

Not implemented. These Office.js members throw: font.

ListLevelCollection

Word.ListLevelCollection: always Word’s nine levels. Import from @reductoai/docx/officejs.

ListLevelCollection properties

ListLevelCollection.at()

ListLevelCollection.getFirst()

ListLevelCollection.getFirstOrNullObject()

OfficeJS null-object variant; inspect isNullObject before other members.

ListLevelCollection.getItem()

OfficeJS spelling of at().

ListLevelCollection.getLast()

ListLevelCollection.getLastOrNullObject()

OfficeJS null-object variant; inspect isNullObject before other members.

ListTemplate

The numbering definition of one list: its nine levels, name and outline flag. Import from @reductoai/docx/officejs.

ListTemplate properties

ListTemplate.set()