DocumentBase.Lists Property
Gets a Lists collection that contains all the formatted lists in the document.
Namespace: Microsoft.Office.Tools.Word
Assembly: Microsoft.Office.Tools.Word.v4.0.Utilities (in Microsoft.Office.Tools.Word.v4.0.Utilities.dll)
Syntax
'Declaration
Public ReadOnly Property Lists As Lists
public Lists Lists { get; }
Property Value
Type: Microsoft.Office.Interop.Word.Lists
A Lists collection that contains all the formatted lists in the document.
Examples
The following code example adds text to the first two paragraphs, applies a list template to the paragraphs, and then displays a message that shows the number of lists in the document. To use this example, run it from the ThisDocument class in a document-level project.
Private Sub DocumentLists()
Me.Paragraphs(1).Range.InsertParagraphBefore()
Me.Paragraphs(1).Range.InsertParagraphAfter()
Me.Paragraphs(1).Range.Text = "This is the first paragraph."
Me.Paragraphs(2).Range.Text = "This is the second paragraph."
Dim Start As Object = Me.Paragraphs(1).Range.Start
Dim [End] As Object = Me.Paragraphs(2).Range.End
Dim myRange As Word.Range = Me.Range(Start, [End])
Dim index As Object = 1
Dim myTemplate As Word.ListTemplate = Application.ListGalleries( _
Microsoft.Office.Interop.Word.WdListGalleryType.wdNumberGallery). _
ListTemplates.Item(index)
myRange.ListFormat.ApplyListTemplate(myTemplate)
MessageBox.Show("Total lists in document: " & Me.Lists.Count.ToString())
End Sub
private void DocumentLists()
{
this.Paragraphs[1].Range.InsertParagraphBefore();
this.Paragraphs[1].Range.InsertParagraphAfter();
this.Paragraphs[1].Range.Text = "This is the first paragraph.";
this.Paragraphs[2].Range.Text = "This is the second paragraph.";
object Start = this.Paragraphs[1].Range.Start;
object End = this.Paragraphs[2].Range.End;
Word.Range myRange = this.Range(ref Start,
ref End);
object index = 1;
Word.ListTemplate myTemplate = Application.ListGalleries[Microsoft.Office.Interop.Word.WdListGalleryType.wdNumberGallery].ListTemplates.get_Item(ref index);
myRange.ListFormat.ApplyListTemplate(myTemplate,
ref missing, ref missing, ref missing);
MessageBox.Show ("Total lists in document: " +
this.Lists.Count.ToString());
}
.NET Framework Security
- Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.