Word.LocationRelation enum

  • Referencia
Paquete:
word

Comentarios

[ Conjunto de API: WordApi 1.3 ]

Ejemplos

// 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 esta instancia tiene lugar después del intervalo y es adyacente a él.
adjacentBefore = "AdjacentBefore"

Indica que esta instancia se produce antes del intervalo y es adyacente a él.
after = "After"

Indica que esta instancia se produce después del intervalo.
before = "Before"

Indica que esta instancia se produce antes del intervalo.
contains = "Contains"

Indica que esta instancia contiene el intervalo, con la excepción del carácter inicial y final de esta instancia.
containsEnd = "ContainsEnd"

Indica que esta instancia contiene el intervalo y que comparte el mismo carácter final. El intervalo no comparte el mismo carácter de inicio que esta instancia.
containsStart = "ContainsStart"

Indica que esta instancia contiene el intervalo y que comparte el mismo carácter de inicio. El intervalo no comparte el mismo carácter final que esta instancia.
equal = "Equal"

Indica que esta instancia y el intervalo representan el mismo intervalo.
inside = "Inside"

Indica que esta instancia está dentro del intervalo. El intervalo no comparte los mismos caracteres inicial y final que esta instancia.
insideEnd = "InsideEnd"

Indica que esta instancia está dentro del intervalo y que comparte el mismo carácter final. El intervalo no comparte el mismo carácter de inicio que esta instancia.
insideStart = "InsideStart"

Indica que esta instancia está dentro del intervalo y que comparte el mismo carácter de inicio. El intervalo no comparte el mismo carácter final que esta instancia.
overlapsAfter = "OverlapsAfter"

Indica que esta instancia se inicia dentro del intervalo y se superpone al último carácter del intervalo.
overlapsBefore = "OverlapsBefore"

Indica que esta instancia se inicia antes del intervalo y se superpone con el primer carácter del intervalo.
unrelated = "Unrelated"

Indica que esta instancia y el intervalo están en sub-documentos diferentes.