Word.LocationRelation enum

  • リファレンス
パッケージ:
word

注釈

[ API セット: WordApi 1.3 ]

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/35-ranges/compare-location.yaml

// Compares the location of one paragraph in relation to another paragraph.
await Word.run(async (context) => {
  const paragraphs: Word.ParagraphCollection = context.document.body.paragraphs;
  paragraphs.load("items");

  await context.sync();

  const firstParagraphAsRange: Word.Range = paragraphs.items[0].getRange();
  const secondParagraphAsRange: Word.Range = paragraphs.items[1].getRange();

  const comparedLocation = firstParagraphAsRange.compareLocationWith(secondParagraphAsRange);

  await context.sync();

  const locationValue: Word.LocationRelation = comparedLocation.value;
  console.log(`Location of the first paragraph in relation to the second paragraph: ${locationValue}`);
});

フィールド

adjacentAfter = "AdjacentAfter"

このインスタンスが範囲の後に発生し、隣接していることを示します。
adjacentBefore = "AdjacentBefore"

このインスタンスが範囲の前に発生し、隣接していることを示します。
after = "After"

このインスタンスが範囲の後に発生することを示します。
before = "Before"

このインスタンスが範囲の前に発生することを示します。
contains = "Contains"

このインスタンスの開始文字と終了文字を除き、このインスタンスに範囲が含まれていることを示します。
containsEnd = "ContainsEnd"

このインスタンスに範囲が含まれており、同じ終了文字を共有していることを示します。 範囲は、このインスタンスと同じ開始文字を共有しません。
containsStart = "ContainsStart"

このインスタンスに範囲が含まれており、同じ開始文字を共有していることを示します。 範囲は、このインスタンスと同じ終了文字を共有しません。
equal = "Equal"

このインスタンスと範囲が同じ範囲を表していることを示します。
inside = "Inside"

このインスタンスが範囲内にあることを示します。 範囲は、このインスタンスと同じ開始文字と終了文字を共有しません。
insideEnd = "InsideEnd"

このインスタンスが範囲内にあり、同じ終了文字を共有していることを示します。 範囲は、このインスタンスと同じ開始文字を共有しません。
insideStart = "InsideStart"

このインスタンスが範囲内にあり、同じ開始文字を共有していることを示します。 範囲は、このインスタンスと同じ終了文字を共有しません。
overlapsAfter = "OverlapsAfter"

このインスタンスが範囲内で開始され、範囲の最後の文字と重なっていることを示します。
overlapsBefore = "OverlapsBefore"

このインスタンスが範囲の前に開始され、範囲の最初の文字と重なっていることを示します。
unrelated = "Unrelated"

このインスタンスと範囲が異なるサブドキュメント内にあることを示します。