Word.ListItem class

包:

word

表示段落列表项格式。

Extends

OfficeExtension.ClientObject

注解

[ API 集：WordApi 1.3 ]

属性

context	与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。
level	指定列表中项的级别。
listString	以字符串的形式获取列表项项目符号、数字或图片。
siblingIndex	获取 listItem 相对于同级元素的序号。

方法

getAncestor(parentOnly)	获取列表项父项，如果父项不存在，则获取最接近的上级。 ItemNotFound如果列表项没有上级，则引发错误。
getAncestorOrNullObject(parentOnly)	获取列表项父项，如果父项不存在，则获取最接近的上级。 如果列表项没有上级，则此方法将返回对象，其 isNullObject 属性设置为 true。 有关详细信息，请参阅 *OrNullObject 方法和属性。
getDescendants(directChildrenOnly)	获取相应列表项目的所有后代列表项目。
load(options)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
set(properties, options)	同时设置对象的多个属性。 可以传递具有相应属性的纯对象，也可以传递同一类型的另一个 API 对象。
set(properties)	基于现有的已加载对象，同时对对象设置多个属性。
toJSON()	重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，反过来又调用toJSON传递给它的 对象的 方法。) 而原始Word。ListItem 对象是一个 API 对象，toJSON该方法返回一个纯 JavaScript 对象， (类型为 Word.Interfaces.ListItemData) ，其中包含原始对象中加载的任何子属性的浅表副本。
track()	根据文档中的相应更改来跟踪对象，以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果跨 .sync 调用和“.run”批处理的顺序执行外部使用此对象，并在设置属性或调用对象方法时收到“InvalidObjectPath”错误，则需要在首次创建对象时将该对象添加到跟踪的对象集合。 如果此对象是集合的一部分，则还应跟踪父集合。
untrack()	释放与此对象关联的内存（如果先前已跟踪过）。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。 在内存发布生效之前，需要调用 context.sync() 。

属性详细信息

context

与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。

context: RequestContext;

属性值

Word.RequestContext

level

指定列表中项的级别。

level: number;

属性值

number

注解

[ API 集：WordApi 1.3 ]

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/20-lists/insert-list.yaml

// This example starts a new list with the second paragraph.
await Word.run(async (context) => {
  const paragraphs = context.document.body.paragraphs;
  paragraphs.load("$none");

  await context.sync();

  // Start new list using the second paragraph.
  const list = paragraphs.items[1].startNewList();
  list.load("$none");

  await context.sync();

  // To add new items to the list, use Start or End on the insertLocation parameter.
  list.insertParagraph("New list item at the start of the list", "Start");
  const paragraph = list.insertParagraph("New list item at the end of the list (set to list level 5)", "End");

  // Set up list level for the list item.
  paragraph.listItem.level = 4;

  // To add paragraphs outside the list, use Before or After.
  list.insertParagraph("New paragraph goes after (not part of the list)", "After");

  await context.sync();
});

listString

以字符串的形式获取列表项项目符号、数字或图片。

readonly listString: string;

属性值

string

注解

[ API 集：WordApi 1.3 ]

siblingIndex

获取 listItem 相对于同级元素的序号。

readonly siblingIndex: number;

属性值

number

注解

[ API 集：WordApi 1.3 ]

方法详细信息

getAncestor(parentOnly)

获取列表项父项，如果父项不存在，则获取最接近的上级。 ItemNotFound如果列表项没有上级，则引发错误。

getAncestor(parentOnly?: boolean): Word.Paragraph;

参数

parentOnly

boolean

可选。 指定仅返回列表项的父级。 默认值为 false，指定获取最低上级。

返回

Word.Paragraph

注解

[ API 集：WordApi 1.3 ]

getAncestorOrNullObject(parentOnly)

获取列表项父项，如果父项不存在，则获取最接近的上级。 如果列表项没有上级，则此方法将返回对象，其 isNullObject 属性设置为 true。 有关详细信息，请参阅 *OrNullObject 方法和属性。

getAncestorOrNullObject(parentOnly?: boolean): Word.Paragraph;

参数

parentOnly

boolean

可选。 指定仅返回列表项的父级。 默认值为 false，指定获取最低上级。

返回

Word.Paragraph

注解

[ API 集：WordApi 1.3 ]

getDescendants(directChildrenOnly)

获取相应列表项目的所有后代列表项目。

getDescendants(directChildrenOnly?: boolean): Word.ParagraphCollection;

参数

directChildrenOnly

boolean

可选。 指定仅返回列表项的直接子级。 默认值为 false，指示获取所有后代项。

返回

Word.ParagraphCollection

注解

[ API 集：WordApi 1.3 ]

load(options)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

load(options?: Word.Interfaces.ListItemLoadOptions): Word.ListItem;

参数

options

Word.Interfaces.ListItemLoadOptions

提供要加载对象的属性的选项。

返回

Word.ListItem

load(propertyNames)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

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

参数

propertyNames

string | string[]

逗号分隔的字符串或指定要加载的属性的字符串数组。

返回

Word.ListItem

load(propertyNamesAndPaths)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

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

参数

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select 是一个逗号分隔的字符串，指定要加载的属性，是 propertyNamesAndPaths.expand 一个逗号分隔的字符串，指定要加载的导航属性。

返回

Word.ListItem

set(properties, options)

同时设置对象的多个属性。 可以传递具有相应属性的纯对象，也可以传递同一类型的另一个 API 对象。

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

参数

properties

Word.Interfaces.ListItemUpdateData

一个 JavaScript 对象，其属性按同构方式构造为调用方法的对象的属性。

options

OfficeExtension.UpdateOptions

提供一个选项，用于在 properties 对象尝试设置任何只读属性时禁止显示错误。

返回

void

set(properties)

基于现有的已加载对象，同时对对象设置多个属性。

set(properties: Word.ListItem): void;

参数

properties

Word.ListItem

返回

void

toJSON()

重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，反过来又调用toJSON传递给它的 对象的 方法。) 而原始Word。ListItem 对象是一个 API 对象，toJSON该方法返回一个纯 JavaScript 对象， (类型为 Word.Interfaces.ListItemData) ，其中包含原始对象中加载的任何子属性的浅表副本。

toJSON(): Word.Interfaces.ListItemData;

返回

Word.Interfaces.ListItemData

track()

根据文档中的相应更改来跟踪对象，以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果跨 .sync 调用和“.run”批处理的顺序执行外部使用此对象，并在设置属性或调用对象方法时收到“InvalidObjectPath”错误，则需要在首次创建对象时将该对象添加到跟踪的对象集合。 如果此对象是集合的一部分，则还应跟踪父集合。

track(): Word.ListItem;

返回

Word.ListItem

untrack()

释放与此对象关联的内存（如果先前已跟踪过）。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。 在内存发布生效之前，需要调用 context.sync() 。

untrack(): Word.ListItem;

返回

Word.ListItem