[Word] Add snippets for APIs re pages, panes, windows #974
Conversation
| order: 4 | ||
| id: word-ranges-get-pages | ||
| name: 'Work with pages, panes, and windows' | ||
| description: 'Shows how to work with pages, panes, and windows APIs.' |
There was a problem hiding this comment.
I think that we're working with APIs is already implied since we're in Script Lab.
| description: 'Shows how to work with pages, panes, and windows APIs.' | |
| description: 'Shows how to work with pages, panes, and windows.' |
|
|
||
| async function getPagesOfThirdParagraph() { | ||
| await Word.run(async (context) => { | ||
| // Gets the pages that the third paragraph is found on. |
There was a problem hiding this comment.
The dangling "on" seemed off, but I think this is the most concise way to articulate the relationships.
| // Gets the pages that the third paragraph is found on. | |
| // Gets the pages that contain the third paragraph. |
|
|
||
| const pages: Word.PageCollection = rangeOfParagraph.pages; | ||
| pages.load(); | ||
| await context.sync(); |
There was a problem hiding this comment.
Do we really need three roundtrips to the document before even getting to the API in question? If so, that seems like a product flaw.
| // Gets the pages enclosing the viewport. | ||
|
|
||
| // Get the active window. | ||
| let activeWindow = context.document.activeWindow; |
There was a problem hiding this comment.
We switched from let to const partway through the snippet. Let's use const here and elsewhere.
| let activeWindow = context.document.activeWindow; | |
| const activeWindow = context.document.activeWindow; |
| await context.sync(); | ||
| // Get pages enclosing the viewport. |
There was a problem hiding this comment.
I find adding a blank line after syncs helps with readability.
| await context.sync(); | |
| // Get pages enclosing the viewport. | |
| await context.sync(); | |
| // Get pages enclosing the viewport. |
| for (let i = 0; i < pages.items.length; i++) { | ||
| let page = pages.items[i]; | ||
| page.load(); | ||
| await context.sync(); |
There was a problem hiding this comment.
We should avoid doing load/sync in a loop. It's a bad pattern. This article has some tips to avoid that: https://learn.microsoft.com/en-us/office/dev/add-ins/concepts/correlated-objects-pattern
| template: | ||
| content: |- | ||
| <section class="ms-Fabric ms-font-m"> | ||
| This sample demonstrates how to work with the pages, panes, and windows APIs. |
There was a problem hiding this comment.
| This sample demonstrates how to work with the pages, panes, and windows APIs. | |
| This sample demonstrates how to work with pages, panes, and windows. |
Will do object mapping later