Word.ListLevel class

包:: word

表示列表级别。

扩展: OfficeExtension.ClientObject

注解

示例

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

// Gets the properties of the specified style.
await Word.run(async (context) => {
  const styleName = (document.getElementById("style-name-to-use") as HTMLInputElement).value;
  if (styleName == "") {
    console.warn("Enter a style name to get properties.");
    return;
  }

  const style: Word.Style = context.document.getStyles().getByNameOrNullObject(styleName);
  style.load("type");
  await context.sync();

  if (style.isNullObject || style.type != Word.StyleType.list) {
    console.warn(`There's no existing style with the name '${styleName}'. Or this isn't a list style.`);
  } else {
    // Load objects to log properties and their values in the console.
    style.load();
    style.listTemplate.load();
    await context.sync();

    console.log(`Properties of the '${styleName}' style:`, style);

    const listLevels = style.listTemplate.listLevels;
    listLevels.load("items");
    await context.sync();

    console.log(`List levels of the '${styleName}' style:`, listLevels);
  }
});

属性

alignment	指定列表级别的水平对齐方式。该值可以是 `left`、 `centered`或 `right`。
context	与对象关联的请求上下文。这会将加载项的进程连接到 Office 主机应用程序的进程。
font	获取表示 `Font` 对象的字符格式的 `ListLevel` 对象。
linkedStyle	指定链接到 `ListLevel` 对象的样式的名称。
numberFormat	指定列表级别的数字格式。
numberPosition	指定对象的数量或项目符号) 位置 (以磅为单位 `ListLevel` 。
numberStyle	指定对象的数字样式 `ListLevel` 。
resetOnHigher	指定在重新编号为 1 之前必须显示的列表级别。
startAt	指定对象的起始编号 `ListLevel` 。
tabPosition	指定对象的选项卡位置 `ListLevel` 。
textPosition	指定对象第二行换行文本 (的位置（以磅) 为单位 `ListLevel` ）。
trailingCharacter	指定在列表级别的数字之后插入的字符。

方法

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.ListLevel`对象是 API 对象，`toJSON`但该方法返回一个纯 JavaScript 对象， (类型为 `Word.Interfaces.ListLevelData`) ，其中包含从原始对象加载的任何子属性的浅表副本。
track()	根据文档中的相应更改来跟踪对象，以便进行自动调整。此调用是 context.trackedObjects.add (thisObject) 的简写。如果跨 `.sync` 调用和“.run”批处理的顺序执行外部使用此对象，并在设置属性或调用对象方法时收到“InvalidObjectPath”错误，则需要在首次创建对象时将该对象添加到跟踪的对象集合。如果此对象是集合的一部分，则还应跟踪父集合。
untrack()	释放与此对象关联的内存（如果先前已跟踪过）。此调用是 context.trackedObjects.remove (thisObject) 的简写。拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。在内存发布生效之前，需要调用 `context.sync()` 。

属性详细信息

alignment

指定列表级别的水平对齐方式。该值可以是 left、 centered或 right。

alignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified";

属性值

注解

[ API 集：WordApiDesktop 1.1 ]

context

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

context: RequestContext;

属性值

Word.RequestContext

font

获取表示 Font 对象的字符格式的 ListLevel 对象。

readonly font: Word.Font;

属性值

Word.Font

注解

[ API 集：WordApiDesktop 1.1 ]

linkedStyle

指定链接到 ListLevel 对象的样式的名称。

linkedStyle: string;

属性值

string

注解

[ API 集：WordApiDesktop 1.1 ]

numberFormat

指定列表级别的数字格式。

numberFormat: string;

属性值

string

注解

[ API 集：WordApiDesktop 1.1 ]

numberPosition

指定对象的数量或项目符号) 位置 (以磅为单位 ListLevel 。

numberPosition: number;

属性值

number

注解

[ API 集：WordApiDesktop 1.1 ]

numberStyle

指定对象的数字样式 ListLevel 。

numberStyle: Word.ListBuiltInNumberStyle | "None" | "Arabic" | "UpperRoman" | "LowerRoman" | "UpperLetter" | "LowerLetter" | "Ordinal" | "CardinalText" | "OrdinalText" | "Kanji" | "KanjiDigit" | "AiueoHalfWidth" | "IrohaHalfWidth" | "ArabicFullWidth" | "KanjiTraditional" | "KanjiTraditional2" | "NumberInCircle" | "Aiueo" | "Iroha" | "ArabicLZ" | "Bullet" | "Ganada" | "Chosung" | "GBNum1" | "GBNum2" | "GBNum3" | "GBNum4" | "Zodiac1" | "Zodiac2" | "Zodiac3" | "TradChinNum1" | "TradChinNum2" | "TradChinNum3" | "TradChinNum4" | "SimpChinNum1" | "SimpChinNum2" | "SimpChinNum3" | "SimpChinNum4" | "HanjaRead" | "HanjaReadDigit" | "Hangul" | "Hanja" | "Hebrew1" | "Arabic1" | "Hebrew2" | "Arabic2" | "HindiLetter1" | "HindiLetter2" | "HindiArabic" | "HindiCardinalText" | "ThaiLetter" | "ThaiArabic" | "ThaiCardinalText" | "VietCardinalText" | "LowercaseRussian" | "UppercaseRussian" | "LowercaseGreek" | "UppercaseGreek" | "ArabicLZ2" | "ArabicLZ3" | "ArabicLZ4" | "LowercaseTurkish" | "UppercaseTurkish" | "LowercaseBulgarian" | "UppercaseBulgarian" | "PictureBullet" | "Legal" | "LegalLZ";

属性值

注解

[ API 集：WordApiDesktop 1.1 ]

resetOnHigher

指定在重新编号为 1 之前必须显示的列表级别。

resetOnHigher: number;

属性值

number

注解

[ API 集：WordApiDesktop 1.1 ]

startAt

指定对象的起始编号 ListLevel 。

startAt: number;

属性值

number

注解

[ API 集：WordApiDesktop 1.1 ]

tabPosition

指定对象的选项卡位置 ListLevel 。

tabPosition: number;

属性值

number

注解

[ API 集：WordApiDesktop 1.1 ]

textPosition

指定对象第二行换行文本 (的位置（以磅) 为单位 ListLevel ）。

textPosition: number;

属性值

number

注解

[ API 集：WordApiDesktop 1.1 ]

trailingCharacter

指定在列表级别的数字之后插入的字符。

trailingCharacter: Word.TrailingCharacter | "TrailingTab" | "TrailingSpace" | "TrailingNone";

属性值

Word.TrailingCharacter | "TrailingTab" | "TrailingSpace" | "TrailingNone"

注解

[ API 集：WordApiDesktop 1.1 ]

方法详细信息

load(options)

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

load(options?: Word.Interfaces.ListLevelLoadOptions): Word.ListLevel;

参数

options: Word.Interfaces.ListLevelLoadOptions

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

Word.ListLevel

load(propertyNames)

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

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

参数

propertyNames: string | string[]

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

Word.ListLevel

load(propertyNamesAndPaths)

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

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

参数

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

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

Word.ListLevel

set(properties, options)

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

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

参数

properties: Word.Interfaces.ListLevelUpdateData

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

options: OfficeExtension.UpdateOptions

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

void

set(properties)

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

set(properties: Word.ListLevel): void;

参数

properties: Word.ListLevel

void

toJSON()

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

toJSON(): Word.Interfaces.ListLevelData;

Word.Interfaces.ListLevelData

track()

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

track(): Word.ListLevel;

Word.ListLevel

untrack()

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

untrack(): Word.ListLevel;

Word.ListLevel

反馈

此页面是否有帮助？

通过

Word.ListLevel class

注解

示例

属性

方法

属性详细信息

alignment

属性值

注解

context

属性值

font

属性值

注解

linkedStyle

属性值

注解

numberFormat

属性值

注解

numberPosition

属性值

注解

numberStyle

属性值

注解

resetOnHigher

属性值

注解

startAt

属性值

注解

tabPosition

属性值

注解

textPosition

属性值

注解

trailingCharacter

属性值

注解

方法详细信息

load(options)

参数

返回

load(propertyNames)

参数

返回

load(propertyNamesAndPaths)

参数

返回

set(properties, options)

参数

返回

set(properties)

参数

返回

toJSON()

返回

track()

返回

untrack()

返回

反馈