mirror of
https://github.com/microsoft/PowerToys.git
synced 2024-12-15 20:19:17 +08:00
28eb4c80f6
* Adding OneNote plugin for PowerToys Run * Updating to 3.0.1 dependency, updating md, spellcheck, ready for PR * Updating spelling and using localized string * Adding OneNote link to readme * Adding OneNote requirement to description * removing 'open' from description * Updating interop version, PR feedback * Adding query caching and delayedExecution to PT Run OneNote plugin * Adding binaries to signing, and updating doc * Adding dependency nuget package binaries to installer * PR feedback and .editorconfig fix to ignore IDE rules that conflict with repo styling * Fixing spelling
39 lines
1.2 KiB
Markdown
39 lines
1.2 KiB
Markdown
# OneNote Plugin
|
|
The OneNote plugin searches your locally synced OneNote notebooks based on the user query.
|
|
|
|
|
|
|
|
The code itself is very simple, basically just a call into OneNote interop via the https://github.com/scipbe/ScipBe-Common-Office library.
|
|
|
|
```csharp
|
|
var pages = OneNoteProvider.FindPages(query.Search);
|
|
```
|
|
|
|
The query results will be cached for 1 day, and if cached results are found they'll be returned in the initial `Query()` call, otherwise OneNote itself will be queried in the `delayedExecution:true` overload.
|
|
|
|
If the user actions on a result, it'll open it in the OneNote app, and restore and/or focus the app as well if necessary.
|
|
|
|
```csharp
|
|
if (PInvoke.IsIconic(handle))
|
|
{
|
|
PInvoke.ShowWindow(handle, SHOW_WINDOW_CMD.SW_RESTORE);
|
|
}
|
|
|
|
PInvoke.SetForegroundWindow(handle);
|
|
```
|
|
|
|
The plugin attempts to call the library in the constructor, and if it fails with a COMException then it'll note that OneNote isn't available and not attempt to query it again.
|
|
|
|
```csharp
|
|
try
|
|
{
|
|
_ = OneNoteProvider.PageItems.Any();
|
|
_oneNoteInstalled = true;
|
|
}
|
|
catch (COMException)
|
|
{
|
|
// OneNote isn't installed, plugin won't do anything.
|
|
_oneNoteInstalled = false;
|
|
}
|
|
```
|