You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: uwp/launch-resume/launch-screen-snipping.md
+8-5Lines changed: 8 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,24 +20,27 @@ The **ms-screenclip:** URI allows your app to automatically open up and start a
20
20
| Parameter | Type | Required | Description |
21
21
| --- | --- | --- | --- |
22
22
| source | string | no | A freeform string to indicate the source that launched the URI. |
23
+
| type | string | no | A string value to indicate which special type of capture is requested. This parameter can be omitted when starting a new snip. Values supported include: snapshot, recording\*|
23
24
| clippingMode | string | no | A string value to indicate the clipping type for the snip. Values supported include: Rectangle, Freeform, Window |
24
25
| delayInSeconds | int | no | An integer value, from 1 to 30. Specifies the delay, in full seconds, between the URI call and when snipping begins. |
25
26
| callbackformat | string | no | This parameter is unavailable. |
26
27
27
-
## Launching the Snip & Sketch App
28
+
\*`type=recording` is available only on Windows 11 PCs with Snipping Tool version 11.2307 or newer, and only when the default handler for ms-screenclip is set to "Snipping Tool" instead of "Screen Clipping".
28
29
29
-
The **ms-screensketch:** URI allows you to programatically launch the Snip & Sketch app, and open a specific image in that app for annotation.
30
+
## Launching the Snipping Tool or Snip & Sketch App
31
+
32
+
The **ms-screensketch:** URI allows you to programatically launch the Snipping Tool app (on Windows 11) or Snip & Sketch app (on Windows 10), and open a specific image in that app for annotation.
30
33
31
34
**ms-screensketch:** takes the following parameters:
32
35
33
36
| Parameter | Type | Required | Description |
34
37
| --- | --- | --- | --- |
35
-
| sharedAccessToken | string | no | A token identifying the file to open in the Snip & Sketch app. Retrieved from [SharedStorageAccessManager.AddFile](/uwp/api/windows.applicationmodel.datatransfer.sharedstorageaccessmanager.addfile). If this parameter is omitted, the app will be launched without a file open. |
38
+
| sharedAccessToken | string | no | A token identifying the file to open. Retrieved from [SharedStorageAccessManager.AddFile](/uwp/api/windows.applicationmodel.datatransfer.sharedstorageaccessmanager.addfile). If this parameter is omitted, the app will be launched without a file open. |
36
39
| secondarySharedAccessToken | string | no | A string identifying a JSON file with metadata about the snip. The metadata may include a **clipPoints** field with an array of x,y coordinates, and/or a [userActivity](/uwp/api/windows.applicationmodel.useractivities.useractivity). |
37
40
| source | string | no | A freeform string to indicate the source that launched the URI. |
38
-
| isTemporary | bool | no | If set to True, Screen Sketch will try to delete the file after opening it. |
41
+
| isTemporary | bool | no | If set to True, Snipping Tool will try to delete the file after opening it. |
39
42
40
-
The following example calls the [LaunchUriAsync](/uwp/api/Windows.System.Launcher#Windows_System_Launcher_LaunchUriAsync_Windows_Foundation_Uri_) method to send an image to Snip & Sketch from the user's app.
43
+
The following example calls the [LaunchUriAsync](/uwp/api/Windows.System.Launcher#Windows_System_Launcher_LaunchUriAsync_Windows_Foundation_Uri_) method to send an image to Snipping Tool from the user's app.
0 commit comments