Word.GetTextOptions interface

パッケージ:

word

getText 操作に含めるオプションを指定します。

注釈

[ API セット: WordApi 1.7 ]

例

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

プロパティ

includeHiddenText	GetText メソッドの結果に非表示のテキストを含めるかどうかを示す値を指定します。 既定値は False です。
includeTextMarkedAsDeleted	GetText メソッドの結果に削除済みとしてマークされたテキストを含めるかどうかを示す値を指定します。 既定値は False です。

プロパティの詳細

includeHiddenText

GetText メソッドの結果に非表示のテキストを含めるかどうかを示す値を指定します。 既定値は False です。

includeHiddenText?: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi 1.7 ]

includeTextMarkedAsDeleted

GetText メソッドの結果に削除済みとしてマークされたテキストを含めるかどうかを示す値を指定します。 既定値は False です。

includeTextMarkedAsDeleted?: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi 1.7 ]