ListFormat Interface

Definition

Namespace:

Microsoft.Office.Interop.Word

Assembly:

Microsoft.Office.Interop.Word.dll

Represents the list formatting attributes that can be applied to the paragraphs in a range.

public interface class ListFormat

[System.Runtime.InteropServices.Guid("000209C0-0000-0000-C000-000000000046")]
public interface ListFormat

type ListFormat = interface

Public Interface ListFormat

Attributes

GuidAttribute

Remarks

Use the ListFormat property to return the ListFormat object for a range.

An easy way to apply list formatting is to use the ApplyBulletDefault(Object), ApplyNumberDefault(Object), and ApplyOutlineNumberDefault(Object) methods, which correspond, respectively, to the first list format (excluding None) on each tab in the Bullets and Numbering dialog box.

To apply a format other than the default format, use the ApplyListTemplate(ListTemplate, Object, Object, Object) method, which allows you to specify the list format (list template) you want to apply.

Use the List or ListTemplate property to return the list or list template from the first paragraph in the specified range.

Use the ListFormat property of a Range object to access the list formatting properties and methods available for the specified range.

However, if there's already a list defined in your document, you can access a List object by using the Lists property.

Properties

Application	Returns a Application object that represents the Microsoft Word application.
Creator	Returns a 32-bit integer that indicates the application in which the specified object was created.
List	Returns a List object that represents the first formatted list contained in the specified ListFormat object.
ListLevelNumber	Returns or sets the list level for the first paragraph in the specified ListFormat object.
ListPictureBullet	Returns the InlineShape object that represents the picture used as a bullet in a picture bullet list.
ListString	Returns a String that represents the appearance of the list value of the first paragraph in the range for the specified ListFormat object. For example, the second paragraph in an alphabetic list would return B.
ListTemplate	Returns a ListTemplate object that represents the list formatting for the specified ListFormat object.
ListType	Returns the type of lists that are contained in the range for the specified ListFormat object.
ListValue	Returns the numeric value of the first paragraph in the range for the specified ListFormat object. For example, the ListValue property applied to the second paragraph in an alphabetic list would return 2.
Parent	Returns an object that represents the parent object of the specified object.
SingleList	True if the specified ListFormat object contains only one list.
SingleListTemplate	True if the entire ListFormat object uses the same list template.

Methods

ApplyBulletDefault(Object)	Adds bullets and formatting to the paragraphs in the range for the specified ListFormat object. If the paragraphs are already formatted with bullets, this method removes the bullets and formatting.
ApplyBulletDefaultOld()	Reserved for internal use.
ApplyListTemplate(ListTemplate, Object, Object, Object)	Applies a set of list-formatting characteristics to the specified ListFormat object.
ApplyListTemplateOld(ListTemplate, Object, Object)	Reserved for internal use.
ApplyListTemplateWithLevel(ListTemplate, Object, Object, Object, Object)	Applies a set of list-formatting characteristics, optionally for a specified level.
ApplyNumberDefault(Object)	Adds the default numbering scheme to the paragraphs in the range for the specified ListFormat object. If the paragraphs are already formatted as a numbered list, this method removes the numbers and formatting.
ApplyNumberDefaultOld()	Reserved for internal use.
ApplyOutlineNumberDefault(Object)	Adds the default outline-numbering scheme to the paragraphs in the range for the specified ListFormat object. If the paragraphs are already formatted as an outline-numbered list, this method removes the numbers and formatting.
ApplyOutlineNumberDefaultOld()	Reserved for internal use.
CanContinuePreviousList(ListTemplate)	Returns a WdContinue constant (wdContinueDisabled, wdResetList, or wdContinueList) that indicates whether the formatting from the previous list can be continued.
ConvertNumbersToText(Object)	Changes the list numbers and LISTNUM fields in the specified ListFormat object to text.
CountNumberedItems(Object, Object)	Returns the number of bulleted or numbered items and LISTNUM fields in the specified ListFormat object.
ListIndent()	Increases the list level of the paragraphs in the range for the specified ListFormat object, in increments of one level.
ListOutdent()	Decreases the list level of the paragraphs in the range for the specified ListFormat object, in increments of one level.
RemoveNumbers(Object)	Removes numbers or bullets from the specified ListFormat object.