Word.ListFormatCountNumberedItemsOptions interface

Пакет:

word

Представляет параметры для подсчета нумеруемых элементов в диапазоне.

Комментарии

Набор API: WordApiDesktop 1.3

Используется

• Word. ListFormat: countNumberedItems

Примеры

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

// Counts only the level-2 (sub-level) numbered paragraphs in the body range.
await Word.run(async (context) => {
  const bodyRange: Word.Range = context.document.body.getRange();
  const listFormat: Word.ListFormat = bodyRange.listFormat;

  const options: Word.ListFormatCountNumberedItemsOptions = {
    level: 2,
    numberType: Word.NumberType.paragraph,
  };
  const count: OfficeExtension.ClientResult<number> = listFormat.countNumberedItems(options);
  await context.sync();

  console.log(`Level-2 item count: ${count.value}`);
});

Свойства

level	Если задано значение , указывает уровень для подсчета. Значение по умолчанию равно 1.
numberType	Если задано значение , указывает тип числа для подсчета. Значение по умолчанию — paragraph.

Сведения о свойстве

level

Если задано значение , указывает уровень для подсчета. Значение по умолчанию равно 1.

level?: number;

Значение свойства

number

Комментарии

Набор API: WordApiDesktop 1.3

numberType

Если задано значение , указывает тип числа для подсчета. Значение по умолчанию — paragraph.

numberType?: Word.NumberType | "Paragraph" | "ListNum" | "AllNumbers";

Значение свойства

Word.NumberType | "Paragraph" | "ListNum" | "AllNumbers"

Комментарии

Набор API: WordApiDesktop 1.3