Word.GetTextOptions interface

Paquet:
word

Spécifie les options à inclure dans une opération Paragraph.getText .

Remarques

Jeu d’API : WordApi 1.7

Utilisateur

Exemples

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

Propriétés

includeHiddenText

Si cette option est fournie, indique s’il faut inclure le texte masqué dans le résultat de la Paragraph.getText méthode. La valeur par défaut est false.
includeTextMarkedAsDeleted

Le cas échéant, indique s’il faut inclure le texte marqué comme supprimé dans le résultat de la Paragraph.getText méthode. La valeur par défaut est false.

Détails de la propriété

includeHiddenText

Si cette option est fournie, indique s’il faut inclure le texte masqué dans le résultat de la Paragraph.getText méthode. La valeur par défaut est false.

includeHiddenText?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : WordApi 1.7

includeTextMarkedAsDeleted

Le cas échéant, indique s’il faut inclure le texte marqué comme supprimé dans le résultat de la Paragraph.getText méthode. La valeur par défaut est false.

includeTextMarkedAsDeleted?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : WordApi 1.7