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"

Указывает, что этот экземпляр и диапазон находятся в разных дочерних документах.