Word.LocationRelation enum

Pacote:
word

Representa a relação do local dessa instância com outro intervalo.

Comentários

Conjunto de APIs: WordApi 1.3

Usada por

Exemplos

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

Campos

adjacentAfter = "AdjacentAfter"

Indica que essa instância ocorre após o intervalo e é adjacente a ele.
adjacentBefore = "AdjacentBefore"

Indica que essa instância ocorre antes e é adjacente ao intervalo.
after = "After"

Indica que essa instância ocorre após o intervalo.
before = "Before"

Indica que essa instância ocorre antes do intervalo.
contains = "Contains"

Indica que essa instância contém o intervalo, com exceção do caractere inicial e final dessa instância.
containsEnd = "ContainsEnd"

Indica que essa instância contém o intervalo e que compartilha o mesmo caractere final. O intervalo não compartilha o mesmo caractere inicial que essa instância.
containsStart = "ContainsStart"

Indica que essa instância contém o intervalo e que compartilha o mesmo caractere inicial. O intervalo não compartilha o mesmo caractere final que essa instância.
equal = "Equal"

Indica que esta instância e o intervalo representam o mesmo intervalo.
inside = "Inside"

Indica que esta instância está dentro do intervalo. O intervalo não compartilha os mesmos caracteres de início e término dessa instância.
insideEnd = "InsideEnd"

Indica que essa instância está dentro do intervalo e que compartilha o mesmo caractere final. O intervalo não compartilha o mesmo caractere inicial que essa instância.
insideStart = "InsideStart"

Indica que essa instância está dentro do intervalo e que compartilha o mesmo caractere inicial. O intervalo não compartilha o mesmo caractere final que essa instância.
overlapsAfter = "OverlapsAfter"

Indica que essa instância começa dentro do intervalo e se sobrepõe ao último caractere do intervalo.
overlapsBefore = "OverlapsBefore"

Indica que essa instância começa antes do intervalo e se sobrepõe ao primeiro caractere do intervalo.
unrelated = "Unrelated"

Indica que essa instância e o intervalo estão em subdocumentos diferentes.