Word.LocationRelation enum

  • Référence
Paquet:
word

Remarques

[ Ensemble d’API : WordApi 1.3 ]

Exemples

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

Champs

adjacentAfter = "AdjacentAfter"

Indique que cette instance se produit après et est adjacente à la plage.
adjacentBefore = "AdjacentBefore"

Indique que cette instance se produit avant et est adjacente à la plage.
after = "After"

Indique que cette instance se produit après la plage.
before = "Before"

Indique que cette instance se produit avant la plage.
contains = "Contains"

Indique que cette instance contient la plage, à l’exception des caractères de début et de fin de cette instance.
containsEnd = "ContainsEnd"

Indique que cette instance contient la plage et qu’elle partage le même caractère de fin. La plage ne partage pas le même caractère de début que cette instance.
containsStart = "ContainsStart"

Indique que cette instance contient la plage et qu’elle partage le même caractère de début. La plage ne partage pas le même caractère de fin que cette instance.
equal = "Equal"

Indique que cette instance et la plage représentent la même plage.
inside = "Inside"

Indique que cette instance se trouve à l’intérieur de la plage. La plage ne partage pas les mêmes caractères de début et de fin que cette instance.
insideEnd = "InsideEnd"

Indique que cette instance se trouve à l’intérieur de la plage et qu’elle partage le même caractère de fin. La plage ne partage pas le même caractère de début que cette instance.
insideStart = "InsideStart"

Indique que cette instance se trouve à l’intérieur de la plage et qu’elle partage le même caractère de début. La plage ne partage pas le même caractère de fin que cette instance.
overlapsAfter = "OverlapsAfter"

Indique que cette instance commence à l’intérieur de la plage et chevauche le dernier caractère de la plage.
overlapsBefore = "OverlapsBefore"

Indique que cette instance commence avant la plage et chevauche le premier caractère de la plage.
unrelated = "Unrelated"

Indique que cette instance et la plage se trouvent dans des sous-documents différents.