Freigeben über


Word.ListFormatCountNumberedItemsOptions interface

Stellt Optionen zum Zählen nummerierter Elemente in einem Bereich dar.

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Beispiele

// 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}`);
});

Eigenschaften

level

Wenn angegeben, gibt die zu zählende Ebene an. Der Standardwert ist 1.

numberType

Gibt bei Angabe den Typ der zu zählenden Zahl an. Der Standardwert ist paragraph.

Details zur Eigenschaft

level

Wenn angegeben, gibt die zu zählende Ebene an. Der Standardwert ist 1.

level?: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

numberType

Gibt bei Angabe den Typ der zu zählenden Zahl an. Der Standardwert ist paragraph.

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

Eigenschaftswert

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

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]