Click here to Skip to main content
11,480,082 members (67,178 online)
Click here to Skip to main content

Creating Shell Links (Shortcuts) in .NET Programs Using WSH

, 3 Apr 2003 250.4K 7K 83
Rate this:
Please Sign up or sign in to vote.
It's easy to create shortcuts using the Windows Script Host Object Model

Sample Image - maximum width is 600 pixels

<!------------------------------- STEP 3 ---------------------------><!-- Add the article text. Please use simple formatting (

,

etc) -->

Introduction

It should be a simple matter to programatically create a shortcut on the desktop that links to a particular file. Unfortunately, as far as I know, the .NET Framework does not support this directly. However, by using the Windows Scripting Host Object Model, it takes only a few lines of code to create a shortcut anywhere within the file system. The purpose of this article is to show how to do this and to provide a class with methods that make it even simpler. The demonstration program uses this class to test for the existence of shortcuts and create or delete them with the click of a checkbox.

Shell Links

A standard feature of the Windows operating system is the ability to create a file that provides a link to any other file within the Windows file system. These so-called "Shortcuts" or "Shell Links" are used in many ways. Examples include the shortcuts that appear as icons on the Windows Desktop, the Start menu, the Quick Launch area within the Task Bar, and the "Send To" menu that appears when right-clicking a file in Explorer. These shortcuts are easy to create manually in the Windows GUI, but within a .NET program they typically require the programmer to use Interop.

Windows Scripting Host

The Windows Scripting Host (WSH) enables a number of file system and network operations to be performed from a script file. Fortunately, it is very simple to directly program the WSH in a .NET program by including a reference to the WSH runtime library (IWshRuntimeLibrary). To do this within the Visual Studio .NET IDE, do the following: after creating a new project, right-click on the project name within the Solution Explorer, select "Add Reference", select the "COM" tab, find and select the "Windows Script Host Object Model" in the listbox, click "Select", and then click "OK". Next, include a reference to the library, for example, within a C# file use the following:

            
  using IWshRuntimeLibrary;

Once this groundwork is done, it is nearly trivial to create a Shell Link. 

Creating a Shell Link

The following code is all that is necessary to create a Shell Link using the Windows Scripting Host.

            
  WshShell shell = new WshShell();
  IWshShortcut link = (IWshShortcut)shell.CreateShortcut(LinkPathName);
  link.TargetPath=TargetPathName;
  link.Save();

The IWshShortcut object has a number of properties that allow the programmer to set things like the target path, the icon, the file name, the arguments, etc. You can explore these within Visual Studio using the Object Browser or Intellisense.

The Link Class

The demonstration program includes a class named Link that encapsulates static methods to test for the presence of a shortcut and to create or delete one if necessary. For example, to test for the presence of a desktop shortcut named "Shell Link", use the following code:

                
  DesktopFolder=Environment.GetFolderPath(Environment.SpecialFolder.DesktopDirectory);
  if(Link.Exists(DesktopFolder, "Shell Link"))DoSomething();
  

 

To create or delete a desktop shortcut named "Shell Link" that points to a file whose path is given by TargetPathName, use the following code:

                
  DesktopFolder=Environment.GetFolderPath(Environment.SpecialFolder.DesktopDirectory);
  Link.Update(DesktopFolder, TargetPathName, "Shell Link", Create);

This will create a link if Create is true and delete it if Create is false. If no change is needed, the code will do nothing.

Conclusion

That's all there is to it! It is simple to incorporate WSH in a .NET program. Creating Shell Links is one good reason to do so. You may find other uses for WSH in your programs such as mapping network drives, setting up printer connections, determining the free space on a disk, or any other tasks that can be automated with the Windows Scripting Host.

License

This article has no explicit license attached to it but may contain usage terms in the article text or the download files themselves. If in doubt please contact the author via the discussion board below.

A list of licenses authors might use can be found here

Share

About the Author

Jim Hollenhorst
Researcher
United States United States
Ultrapico Website: http://www.ultrapico.com

Download Expresso 3.0, the latest version of the award-winning regular expression development tool.

Comments and Discussions

 
Questionreference not available in VS 2012 Pin
Husam khiry28-Oct-14 23:52
professionalHusam khiry28-Oct-14 23:52 
AnswerRe: reference not available in VS 2012 Pin
Jim Hollenhorst30-Nov-14 16:11
memberJim Hollenhorst30-Nov-14 16:11 
QuestionException coming when creating shortcut for remote PDF file Pin
Aarvey17-Jul-13 4:46
memberAarvey17-Jul-13 4:46 
AnswerRe: Exception coming when creating shortcut for remote PDF file Pin
Aarvey18-Jul-13 2:23
memberAarvey18-Jul-13 2:23 
QuestionError Creating a Link Pin
arbh8921-Nov-12 5:22
memberarbh8921-Nov-12 5:22 
GeneralMy vote of 5 Pin
Andrewpeter16-Sep-12 18:04
memberAndrewpeter16-Sep-12 18:04 
GeneralRe: My vote of 5 Pin
Jim Hollenhorst27-Sep-12 16:45
memberJim Hollenhorst27-Sep-12 16:45 
QuestionHow to create shortcut without refercene "Windows Script Host"? Pin
Andrewpeter16-Sep-12 18:04
memberAndrewpeter16-Sep-12 18:04 
AnswerRe: How to create shortcut without refercene "Windows Script Host"? Pin
Jim Hollenhorst27-Sep-12 16:49
memberJim Hollenhorst27-Sep-12 16:49 
AnswerRe: How to create shortcut without refercene "Windows Script Host"? Pin
Kerem Guemruekcue14-Nov-12 0:43
memberKerem Guemruekcue14-Nov-12 0:43 
GeneralMy vote of 4 Pin
geekbond11-Aug-12 23:49
membergeekbond11-Aug-12 23:49 
GeneralMy vote of 4 Pin
Burak Tunçbilek17-Jun-12 3:24
memberBurak Tunçbilek17-Jun-12 3:24 
QuestionMyShortcut.TargetPath with a space to make a parameter for the target app Pin
Member 31040542-Feb-10 2:00
memberMember 31040542-Feb-10 2:00 
AnswerRe: MyShortcut.TargetPath with a space to make a parameter for the target app Pin
Member 31040542-Feb-10 2:11
memberMember 31040542-Feb-10 2:11 
GeneralGreat Method Pin
HiteshSharma13-Aug-09 7:47
memberHiteshSharma13-Aug-09 7:47 
GeneralRe: Great Method Pin
Jim Hollenhorst16-Aug-09 11:00
memberJim Hollenhorst16-Aug-09 11:00 
GeneralRe: Great Method Pin
HiteshSharma16-Aug-09 11:29
memberHiteshSharma16-Aug-09 11:29 
GeneralRe: Great Method Pin
jimpar10-Feb-11 6:53
memberjimpar10-Feb-11 6:53 
GeneralRe: Great Method Pin
Jim Hollenhorst13-Mar-11 16:35
memberJim Hollenhorst13-Mar-11 16:35 
GeneralShortcut but no update Pin
mrpdude5-Aug-09 18:28
membermrpdude5-Aug-09 18:28 
GeneralShortcut but no update Pin
mrpdude5-Aug-09 18:27
membermrpdude5-Aug-09 18:27 
GeneralAdding to customer start menu directory Pin
Member 35762719-Aug-08 14:08
memberMember 35762719-Aug-08 14:08 
GeneralRe: Adding to customer start menu directory Pin
Jim Hollenhorst19-Aug-08 17:17
memberJim Hollenhorst19-Aug-08 17:17 
QuestionAlternate credentials Pin
pattarom11-Apr-08 3:07
memberpattarom11-Apr-08 3:07 
GeneralHelp Plz Pin
djsoul12-Mar-08 12:06
memberdjsoul12-Mar-08 12:06 
GeneralSpecified cast is not valid Pin
lianaent3-Nov-06 11:12
memberlianaent3-Nov-06 11:12 
GeneralAll Users Pin
Gfw9-Sep-06 6:04
memberGfw9-Sep-06 6:04 
QuestionHow to Read lnk files through WSH using C#.net Pin
vipinkpr8-Sep-06 3:04
membervipinkpr8-Sep-06 3:04 
GeneralProblems on creating shortcuts Pin
mirceat13-Mar-06 9:05
membermirceat13-Mar-06 9:05 
GeneralRe: Problems on creating shortcuts Pin
Jim Hollenhorst14-Mar-06 6:51
memberJim Hollenhorst14-Mar-06 6:51 
GeneralRe: Problems on creating shortcuts Pin
mirceat14-Mar-06 9:50
membermirceat14-Mar-06 9:50 
GeneralRe: Problems on creating shortcuts Pin
mirceat14-Mar-06 9:59
membermirceat14-Mar-06 9:59 
GeneralRe: Problems on creating shortcuts Pin
Tapas Das17-Aug-07 0:13
memberTapas Das17-Aug-07 0:13 
NewsMC++ Pin
Anonymous26-Aug-05 16:03
sussAnonymous26-Aug-05 16:03 
GeneralRe: MC++ Pin
dborgohain3-Feb-06 10:48
memberdborgohain3-Feb-06 10:48 
GeneralRe: MS VC++ .NET Pin
Alan Hsieh29-Mar-06 12:43
memberAlan Hsieh29-Mar-06 12:43 
GeneralOS Pin
thiaguera1-Feb-05 2:54
memberthiaguera1-Feb-05 2:54 
QuestionCan we use WSH to find highlighted icons on desktop? Pin
u999nik1-Oct-04 9:06
memberu999nik1-Oct-04 9:06 
QuestionCan this be done without a DLL being created? Pin
Jordan Bradford20-Sep-04 15:30
memberJordan Bradford20-Sep-04 15:30 
AnswerRe: Can this be done without a DLL being created? Pin
Jim Hollenhorst20-Sep-04 18:29
memberJim Hollenhorst20-Sep-04 18:29 
AnswerRe: Can this be done without a DLL being created? Pin
Anonymous20-Sep-04 20:30
sussAnonymous20-Sep-04 20:30 
GeneralNice, but here is a better way... Pin
Anonymous4-Apr-03 3:31
sussAnonymous4-Apr-03 3:31 
GeneralRe: Nice, but here is a better way... Pin
Jim Hollenhorst4-Apr-03 5:19
memberJim Hollenhorst4-Apr-03 5:19 
GeneralRe: Nice, but here is a better way... Pin
Dynamite Jones6-Apr-03 8:16
memberDynamite Jones6-Apr-03 8:16 
GeneralRe: Nice, but here is a better way... Pin
mlavenne22-Oct-04 10:29
membermlavenne22-Oct-04 10:29 
GeneralRe: Nice, but here is a better way... Pin
strabu14-Jul-05 4:27
memberstrabu14-Jul-05 4:27 
GeneralRe: Nice, but here is a better way... Pin
papadi1-Apr-07 21:55
memberpapadi1-Apr-07 21:55 
GeneralRe: Nice, but here is a better way... [modified] Pin
RichardCollins222-Oct-07 2:34
memberRichardCollins222-Oct-07 2:34 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

| Advertise | Privacy | Terms of Use | Mobile
Web01 | 2.8.150520.1 | Last Updated 4 Apr 2003
Article Copyright 2003 by Jim Hollenhorst
Everything else Copyright © CodeProject, 1999-2015
Layout: fixed | fluid