Wiki Markup |
---|
{description} {excerpt}This class is used to represent a list in a Word document. Lists are part of the _BlockElement_ objects of an [Element|Element]. Using this class, Lists can be read and written. Lists contain list entries, which are basically paragraphs with additional features.{excerpt} {signature:C#} public sealed class List : Element {signature}{signature:vb.net} Public NotInheritable Class List Inherits Element {signature} {remarks}To create a new list, use [Element.InsertListBefore()|Element.InsertListBefore(Boolean)] or [Element.InsertListAfter()|Element.InsertListAfter(Boolean)]. To get an existing list, use [Element.GetElements(Element.Type)|Element.GetElements(Element.Type)]. {remarks} {example} 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. {code:csharp|title=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]; {code} {code:vb.net|title=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) {code} {example} {properties} ||Name||Description|| |[NumEntries|List.NumEntries]|{excerpt-include:List.NumEntries|nopanel=true}| {methods} ||Name||Description|| |[AddEntry(Int32)|List.AddEntry(Int32)]|{excerpt-include:List.AddEntry(Int32)|nopanel=true}| |[GetEntry(Int32)|List.GetEntry(Int32)]|{excerpt-include:List.GetEntry(Int32)|nopanel=true}| |[GetLevel(Int32)|List.GetLevel(Int32)]|{excerpt-include:List.GetLevel(Int32)|nopanel=true}| |[InsertEntry(Int32, Int32)|List.InsertEntry(Int32, Int32)]|{excerpt-include:List.InsertEntry(Int32, Int32)|nopanel=true}| |
Page History
Overview
Content Tools