Word.GetTextOptions interface

Paket:

word

Gibt die Optionen an, die in einen getText-Vorgang eingeschlossen werden sollen.

Hinweise

[ API-Satz: WordApi 1.7 ]

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/get-text.yaml

await Word.run(async (context) => {
  const paragraph: Word.Paragraph = context.document.getSelection().paragraphs.getFirst();

  const text = paragraph.getText();
  const textIncludingHidden = paragraph.getText({ IncludeHiddenText: true });
  const textIncludingDeleted = paragraph.getText({ IncludeTextMarkedAsDeleted: true });

  await context.sync();

  console.log("Text:- " + text.value, "Including hidden text:- " + textIncludingHidden.value, "Including text marked as deleted:- " + textIncludingDeleted.value);
});

Eigenschaften

includeHiddenText	Gibt einen Wert an, der angibt, ob ausgeblendeter Text in das Ergebnis der GetText-Methode eingeschlossen werden soll. Der Standardwert ist False.
includeTextMarkedAsDeleted	Gibt einen Wert an, der angibt, ob Text eingeschlossen werden soll, der im Ergebnis der GetText-Methode als gelöscht markiert ist. Der Standardwert ist False.

Details zur Eigenschaft

includeHiddenText

Gibt einen Wert an, der angibt, ob ausgeblendeter Text in das Ergebnis der GetText-Methode eingeschlossen werden soll. Der Standardwert ist False.

includeHiddenText?: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApi 1.7 ]

includeTextMarkedAsDeleted

Gibt einen Wert an, der angibt, ob Text eingeschlossen werden soll, der im Ergebnis der GetText-Methode als gelöscht markiert ist. Der Standardwert ist False.

includeTextMarkedAsDeleted?: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApi 1.7 ]