Class ListItem

Represents an item in a multi-level list within the document.

Inheritance
System.Object
ContentElement
ParentElement
ListItem
Implements
IronSoftware.Abstractions.Word.IWordDocumentObject
IronSoftware.Abstractions.IDocumentObject
System.ICloneable
IronSoftware.Abstractions.IParent<IronSoftware.Abstractions.Word.IWordDocumentObjectCollection, IronSoftware.Abstractions.Word.IWordDocumentObject>
Inherited Members
Namespace: IronWord.Models
Assembly: IronWord.dll
Syntax
public class ListItem : ParentElement

A ListItem is the single entry you place into a numbered or bulleted list, the unit a MultiLevelTextList collects to build the list a reader sees. Each item carries the paragraph content shown on its line and can hold a nested list of its own, which is how multi-level outlines form.

You create a list item from a Paragraph (the text for that line) or from a MultiLevelTextList when the item begins a sub-list, then add it to the parent list with AddItem. Index reports the item's position within its list. AddSubMultiLevelTextList attaches a nested list beneath the item to push content down a level, and RemoveSubMultiLevelTextList detaches it again. Update replaces the item's paragraph content in place. Build the entries first, add them to a MultiLevelTextList, and add that list to the document so the numbering and indentation render correctly.

var item = new ListItem(new Paragraph("First step"));

The add list example builds a list end to end, and the add bullet list example shows the bulleted variant.

Constructors

ListItem(MultiLevelTextList)

Initializes a new instance of the ListItem class with the specified child elements.

Declaration
public ListItem(MultiLevelTextList subMultiLevelTextList)
Parameters
Type Name Description
MultiLevelTextList subMultiLevelTextList

The child elements to be added.

ListItem(Paragraph)

Initializes a new instance of the ListItem class with the specified child elements.

Declaration
public ListItem(Paragraph paragraph)
Parameters
Type Name Description
Paragraph paragraph

The child elements to be added.

Properties

Index

Gets the index of this list item.

Declaration
public int Index { get; set; }
Property Value
Type Description
System.Int32

Methods

AddSubMultiLevelTextList(MultiLevelTextList)

Add a sub multi-level text list.

Declaration
public void AddSubMultiLevelTextList(MultiLevelTextList subMultiLevelTextList)
Parameters
Type Name Description
MultiLevelTextList subMultiLevelTextList

The child elements to be added.

RemoveSubMultiLevelTextList()

Removes the sub multi-level text list from this item if this item contains one.

Declaration
public void RemoveSubMultiLevelTextList()

Update(Paragraph)

Update the contents in the list item.

Declaration
public void Update(Paragraph paragraph)
Parameters
Type Name Description
Paragraph paragraph

The paragraph used to update current item content.

Implements

IronSoftware.Abstractions.Word.IWordDocumentObject
IronSoftware.Abstractions.IDocumentObject
System.ICloneable
IronSoftware.Abstractions.IParent<, >

Inherited members

AddChild(IWordDocumentObject[])
InsertChildToIndex(Int32, IWordDocumentObject[])
Remove()
RemoveChildren(IWordDocumentObject[])
RemoveAllChildren()
ExtractElements<T>()
GetChildByIndex<T>(Int32)
Clone()
CloneObject()
LogObjectTree()
Texts
Tables
Children
Replace(IWordDocumentObject)
GetIndex<T>()
Parent
Status