OfficeWriter Documentation
.
WordWriter v9 Docs
Space Shortcuts
Page tree
    Loading...
Skip to end of metadata
Go to start of metadata

Description

This class is used to represent a list in a Word document. Lists are part of the BlockElement objects of an Element. Using this class, Lists can be read and written. Lists contain list entries, which are basically paragraphs with additional features.

C#
?
public sealed class List : Element
vb.net
?
Public NotInheritable Class List
        Inherits Element

Remarks

To create a new list, use Element.InsertListBefore() or Element.InsertListAfter(). To get an existing list, use Element.GetElements(Element.Type).

Examples

The following sample demonstrates how to create a new list at the end of a document as well as how to get the first list of a document.

C#
?
//--- Insert a numbered list at the end of a new document with one entry
WordApplication app = new WordApplication();
Document doc = app.Create();
List lst = doc.InsertListAfter(true);
lst.AddEntry(0);
lst.InsertTextAfter("First list entry.", false);
 
//--- Get the first list of an existing document
WordApplication app = new WordApplication();
Document doc = app.Open(@"C:\sample.doc");
List lst = doc.GetElements(Element.Type.List)[0];
vb.net
?
'--- Insert a numbered list at the end of a new document with one entry
Dim app As New WordApplication()
Dim doc As Document = app.Create()
Dim lst As List = doc.InsertListAfter(True)
lst.AddEntry(0)
lst.InsertTextAfter("First list entry.", False)
 
'--- Get the first list of an existing document
Dim app As New WordApplication()
Dim doc As Document = app.Open("C:\sample.doc")
Dim lst As List = doc.GetElements(Element.Type.List)(0)

Properties

Name

Description

NumEntries

 Returns an int representing the number of contiguous entries in this lst.

Methods

Name

Description

AddEntry(Int32)

 Returns a ListEntry object representing an empty list entry added to the end of the list, which is indented to the level specified. Level can be between 0 and 8 (9 levels total).

GetEntry(Int32)

 Returns a ListEntry object representing the entry at a specified index. The index of list entries starts at 0.

GetLevel(Int32)

 Returns a ListLevel object representing a particular level for this lst. The levels start at 0 and end at 8 (9 levels total).

InsertEntry(Int32, Int32)

 Returns a ListEntry object representing an empty list entry that is inserted at the given index, which is indented to the level specified. index and level start at 0. The maximum level is 8 (9 levels total).
  • No labels