Word.LocationRelation enum
表示此实例的位置与另一个范围的关系。
注解
使用方
示例
// 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: OfficeExtension.ClientResult<Word.LocationRelation> =
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" | 指示此实例和范围位于不同的子文档中。 |