Skip to main content

Border

One border location of a style or of a conditional block, live over its XML. Import from @reductoai/docx/node, @reductoai/docx/officejs.

Border properties

Border.set()

BorderCollection

The border locations one host carries, plus the office.js aggregates. Import from @reductoai/docx/node, @reductoai/docx/officejs.

BorderCollection properties

BorderCollection.getByLocation()

BorderCollection.getFirst()

BorderCollection.getItem()

BorderUniversal

One border location of a paragraph, or of every paragraph a range covers. Reads are effective and neutral on disagreement; writes are direct and reach every covered paragraph. artStyle/artWidth refuse by name. Import from @reductoai/docx/officejs.

BorderUniversal properties

BorderUniversal.set()

Not implemented. These Office.js members throw: artStyle, artWidth.

BorderUniversalCollection

The five paragraph border locations, in VBA’s WdBorderType order. Import from @reductoai/docx/officejs.

BorderUniversalCollection properties

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

ColorFormat

Word.ColorFormat over one DrawingML colour element; rgb writes an a:srgbClr. Import from @reductoai/docx/officejs.

ColorFormat properties

ColorFormat.set()

ConditionalStyle

Formatting of one table area of a table style (w:tblStylePr). Every write creates the block on demand; deleting the last property in it removes the empty block again (extension nicety). Import from @reductoai/docx/node, @reductoai/docx/officejs.

ConditionalStyle properties

DocumentTheme

Extension (VBA Document.DocumentTheme): the document’s Office theme. Import from @reductoai/docx/officejs.

DocumentTheme properties

DropCap

Import from @reductoai/docx/officejs.

DropCap properties

DropCap.clear()

Remove the drop and give the letter back to its paragraph.

DropCap.enable()

Drop the paragraph’s first letter three lines, in the text; a drop already there stays.

DropCap.set()

HeadingStyle

Import from @reductoai/docx/node, @reductoai/docx/officejs.

HeadingStyle properties

HeadingStyle.delete()

HeadingStyle.set()

HeadingStyleCollection

Import from @reductoai/docx/node, @reductoai/docx/officejs.

HeadingStyleCollection properties

HeadingStyleCollection.add()

ParagraphShadingUniversal

Paragraph-backed shading: w:pPr/w:shd, read effective and written direct on every covered paragraph. The disagree rule is TableColumn.shading’s — "" for the colors, “None” for the texture. Import from @reductoai/docx/officejs. Extends ShadingUniversal.

ParagraphShadingUniversal properties

ParagraphShadingUniversal.set()

Shading

The style’s w:shd: w:pPr/w:shd on a paragraph style, w:rPr/w:shd on a character style, w:tcPr/w:shd (whole-table cell shading) on a table style. Import from @reductoai/docx/node, @reductoai/docx/officejs.

Shading properties

Shading.set()

ShadingUniversal

Shading over one backing, including the OOXML foreground/pattern attributes. Import from @reductoai/docx/node, @reductoai/docx/officejs.

ShadingUniversal properties

ShadingUniversal.set()

StyleCollection

Live view over the styles part: every access re-reads w:styles. Import from @reductoai/docx/node, @reductoai/docx/officejs.

StyleCollection properties

StyleCollection.at()

Extension matching the HandleCollection convention; negative indices count from the end.

StyleCollection.getByName()

StyleCollection.getByNameOrNullObject()

StyleCollection.getCount()

StyleCollection.getItem()

ThemeColorScheme

Extension (VBA Document.DocumentTheme.ThemeColorScheme): the twelve colours every theme colour reference resolves through. A change rewrites the colours that use the slot, as Word does. Import from @reductoai/docx/officejs.

ThemeColorScheme properties

ThemeColorScheme.getColor()

VBA Colors(index).RGB, as #RRGGBB.

ThemeColorScheme.load()

VBA ThemeColorScheme.Load with one of Word’s built-in Design > Colors names (“Blue Warm”).

ThemeColorScheme.set()

Several slots in one write.

ThemeColorScheme.setColor()

ThemeFontScheme

Extension (VBA DocumentTheme.ThemeFontScheme): the heading (major) and body (minor) theme faces. Import from @reductoai/docx/officejs.

ThemeFontScheme properties

ThemeFontScheme.load()

VBA ThemeFontScheme.Load with one of Word’s built-in Design > Fonts names (“Office 2013 - 2022”).

ThemeFontScheme.set()

Both faces in one write; the scheme is renamed “Custom”, as Word names an edited one.