Files
velopack/docfx/docs/updating/shortcuts.md
2024-01-27 11:42:17 +00:00

19 lines
997 B
Markdown

*Applies to: Windows*
# Windows Shortcuts
By default, during installation Velopack will create a shortcut on the Desktop and in the StartMenuRoot. It will automatically delete any shortcuts it finds when uninstalling the application.
The name of the shortcuts will be determined by the `--packTitle` vpk argument. For example, if you pass `--packTitle "My Fancy App"`, then the shortcuts created will be created as `"My Fancy App.lnk"`.
If you need to create shortcuts in any extra locations, the `Velopack.Windows.Shortcuts` and `Velopack.Windows.ShellLink` classes are provided. These classes are provided for legacy reasons, and in general the stability of such functions is not guarenteed.
For example, if you wished to create a shortcut during the install of your app, you might do the following:
```cs
using Velopack;
using Velopack.Windows;
VelopackApp.Build()
.WithAfterInstallFastCallback((v) => new Shortcuts().CreateShortcutForThisExe(ShortcutLocation.Desktop))
.Run()
```