Word.GetTextOptions interface

Paquete:
word

Especifica las opciones que se incluirán en una operación Paragraph.getText .

Comentarios

Conjunto de API: WordApi 1.7

Usada por

Ejemplos

// 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}`);
  console.log(`Including hidden text: ${textIncludingHidden.value}`);
  console.log(`Including text marked as deleted: ${textIncludingDeleted.value}`);
});

Propiedades

includeHiddenText

Si se proporciona, especifica si se incluirá texto oculto en el resultado del Paragraph.getText método. El valor predeterminado es false.
includeTextMarkedAsDeleted

Si se proporciona, especifica si se debe incluir texto marcado como eliminado en el resultado del Paragraph.getText método. El valor predeterminado es false.

Detalles de las propiedades

includeHiddenText

Si se proporciona, especifica si se incluirá texto oculto en el resultado del Paragraph.getText método. El valor predeterminado es false.

includeHiddenText?: boolean;

Valor de propiedad

boolean

Comentarios

Conjunto de API: WordApi 1.7

includeTextMarkedAsDeleted

Si se proporciona, especifica si se debe incluir texto marcado como eliminado en el resultado del Paragraph.getText método. El valor predeterminado es false.

includeTextMarkedAsDeleted?: boolean;

Valor de propiedad

boolean

Comentarios

Conjunto de API: WordApi 1.7