Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/

Add Bulleted and Numbered Lists in Word

Edit on GitHub

Create bulleted, numbered, multi-level and custom-numbered lists in DOCX files, start numbering at any value, and read existing list items in .NET.

Packages
Works with
Target frameworks
netstandard2.0, net8.0, net10.0, net472
Verified
Examples compiled against the source on

A WordList is a native Word list backed by a numbering definition, so Word renumbers it as items change. WordListStyle selects a built-in definition: Bulleted, Numbered, LowerLetterWithDot, UpperLetterWithBracket, Headings111, Chapters, and more. Items take a level from 0 to 8 for nesting.

Add a bulleted or numbered list

C#

using OfficeIMO.Word;

using WordDocument document = WordDocument.Create("lists.docx");

document.AddParagraph("Highlights");
WordList bullets = document.AddListBulleted();
bullets.AddItem("Release completed on schedule");
bullets.AddItem("Customer guide updated");

document.AddParagraph("Next steps");
WordList steps = document.AddListNumbered();
steps.AddItem("Review adoption metrics");
steps.AddItem("Plan the next milestone");

document.Save();

PowerShell

New-OfficeWord -Path .\lists.docx {
    Add-OfficeWordParagraph -Text 'Highlights'
    Add-OfficeWordList -Items 'Release completed on schedule', 'Customer guide updated'
    Add-OfficeWordParagraph -Text 'Next steps'
    Add-OfficeWordList -Numbered {
        Add-OfficeWordListItem -Text 'Review adoption metrics'
        Add-OfficeWordListItem -Text 'Plan the next milestone'
    }
}

Nest items in a multi-level list

The second argument of AddItem is the level. Each level gets its own bullet or number format from the list style.

C#

using OfficeIMO.Word;

using WordDocument document = WordDocument.Create("outline.docx");

WordList outline = document.AddList(WordListStyle.Headings111);
outline.AddItem("Scope");
outline.AddItem("In scope", 1);
outline.AddItem("Out of scope", 1);
outline.AddItem("Delivery");
outline.AddItem("Pilot", 1);
outline.AddItem("Pilot sites", 2);

document.Save();

PowerShell

New-OfficeWord -Path .\outline.docx {
    Add-OfficeWordList -Numbered {
        Add-OfficeWordListItem -Text 'Scope'
        Add-OfficeWordListItem -Text 'In scope' -Level 1
        Add-OfficeWordListItem -Text 'Out of scope' -Level 1
        Add-OfficeWordListItem -Text 'Delivery'
    }
}

Format list items

AddItem returns the item's WordParagraph, so you can format it like any paragraph. Settings on the list itself (Bold, Color, FontSize) apply to the numbers or bullets.

C#

using OfficeIMO;
using OfficeIMO.Word;

using WordDocument document = WordDocument.Create("formatted-list.docx");

WordList risks = document.AddList(WordListStyle.Numbered);
risks.Color = OfficeColor.Parse("C00000");
risks.Bold = true;

risks.AddItem("Supplier delay").AddText(" - high impact").SetItalic();
risks.AddItem("Budget overrun");

document.Save();

Start numbering at a specific value

A custom list lets you define the level format and the start value.

C#

using OfficeIMO.Word;

using WordDocument document = WordDocument.Create("continued.docx");

WordList list = document.AddCustomList();
list.Numbering.AddLevel(new WordListLevel(WordListLevelKind.Decimal).SetStartNumberingValue(4));
list.AddItem("Fourth step");
list.AddItem("Fifth step");

document.Save();

Read lists from an existing document

document.Lists returns every list. ListItems gives the paragraphs in order, and each item reports its level.

C#

using OfficeIMO.Word;

using WordDocument document = WordDocument.Load("lists.docx");

foreach (WordList list in document.Lists) {
    Console.WriteLine($"{list.Style} list with {list.ListItems.Count} items");
    foreach (WordParagraph item in list.ListItems) {
        Console.WriteLine($"{new string(' ', (item.ListItemLevel ?? 0) * 2)}- {item.Text}");
    }
}

PowerShell

Get-OfficeWordList -Path .\lists.docx

Example source