Word.ListFormat class

The request context associated with the object. This connects the add-in's process to the Office host application's process.

context: RequestContext;

Property Value

Indicates whether the ListFormat object contains a single list.

readonly isSingleList: boolean;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Indicates whether the ListFormat object contains a single list template.

readonly isSingleListTemplate: boolean;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Returns a List object that represents the first formatted list contained in the ListFormat object.

readonly list: Word.List;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Specifies the list level number for the first paragraph for the ListFormat object.

listLevelNumber: number;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Gets the string representation of the list value of the first paragraph in the range for the ListFormat object.

readonly listString: string;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Gets the list template associated with the ListFormat object.

readonly listTemplate: Word.ListTemplate;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Gets the type of the list for the ListFormat object.

readonly listType: Word.ListType | "ListNoNumbering" | "ListListNumOnly" | "ListBullet" | "ListSimpleNumbering" | "ListOutlineNumbering" | "ListMixedNumbering" | "ListPictureBullet";

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Gets the numeric value of the the first paragraph in the range for the ListFormat object.

readonly listValue: number;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Adds bullets and formatting to the paragraphs in the range.

applyBulletDefault(defaultListBehavior: Word.DefaultListBehavior): void;

Parameters

Returns

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Adds bullets and formatting to the paragraphs in the range.

applyBulletDefault(defaultListBehavior: "Word97" | "Word2000" | "Word2002"): void;

Parameters

Returns

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Applies a list template with a specific level to the paragraphs in the range.

applyListTemplateWithLevel(listTemplate: Word.ListTemplate, options?: Word.ListTemplateApplyOptions): void;

Parameters

Returns

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Adds numbering and formatting to the paragraphs in the range.

applyNumberDefault(defaultListBehavior: Word.DefaultListBehavior): void;

Parameters

Returns

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Adds numbering and formatting to the paragraphs in the range.

applyNumberDefault(defaultListBehavior: "Word97" | "Word2000" | "Word2002"): void;

Parameters

Returns

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Adds outline numbering and formatting to the paragraphs in the range.

applyOutlineNumberDefault(defaultListBehavior: Word.DefaultListBehavior): void;

Parameters

Returns

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Adds outline numbering and formatting to the paragraphs in the range.

applyOutlineNumberDefault(defaultListBehavior: "Word97" | "Word2000" | "Word2002"): void;

Parameters

Returns

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Determines whether the ListFormat object can continue a previous list.

canContinuePreviousList(listTemplate: Word.ListTemplate): OfficeExtension.ClientResult<Word.Continue>;

Parameters

Returns

A Continue value indicating whether continuation is possible.

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Converts numbers in the list to plain text.

convertNumbersToText(numberType: Word.NumberType): void;

Parameters

Returns

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Converts numbers in the list to plain text.

convertNumbersToText(numberType: "Paragraph" | "ListNum" | "AllNumbers"): void;

Parameters

Returns

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Counts the numbered items in the list.

countNumberedItems(options?: Word.ListFormatCountNumberedItemsOptions): OfficeExtension.ClientResult<number>;

Parameters

Returns

The number of items.

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Indents the list by one level.

listIndent(): void;

Returns

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Outdents the list by one level.

listOutdent(): void;

Returns

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(options?: Word.Interfaces.ListFormatLoadOptions): Word.ListFormat;

Parameters

Returns

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNames?: string | string[]): Word.ListFormat;

Parameters

Returns

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.ListFormat;

Parameters

Returns

Removes numbering from the list.

removeNumbers(numberType: Word.NumberType): void;

Parameters

Returns

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Removes numbering from the list.

removeNumbers(numberType: "Paragraph" | "ListNum" | "AllNumbers"): void;

Parameters

Returns

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.

set(properties: Interfaces.ListFormatUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parameters

Returns

Sets multiple properties on the object at the same time, based on an existing loaded object.

set(properties: Word.ListFormat): void;

Parameters

Returns

Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that's passed to it.) Whereas the original Word.ListFormat object is an API object, the toJSON method returns a plain JavaScript object (typed as Word.Interfaces.ListFormatData) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Word.Interfaces.ListFormatData;

Returns

Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you're using this object across .sync calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.

track(): Word.ListFormat;

Returns

Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call context.sync() before the memory release takes effect.

untrack(): Word.ListFormat;

Returns