NanoByte.Common  2.9.0
NanoByte.Common.Native.WindowsTaskbar.ShellLink Struct Reference

Represents a shell link targeting a file. More...

Public Member Functions

 ShellLink ([Localizable(true)] string title, [Localizable(false)] string path, [Localizable(false)] string? arguments=null)
 Creates a new shell link structure. More...
 
 ShellLink ([Localizable(true)] string title, [Localizable(false)] string path, [Localizable(false)] string arguments, [Localizable(false)] string iconPath, int iconIndex)
 Creates a new shell link structure More...
 

Public Attributes

readonly string Title
 The title/name of the task link. More...
 
readonly string Path
 The target path the link shall point to. More...
 
readonly? string Arguments
 Additional arguments for Title; can be null. More...
 
readonly string IconPath
 The path of the icon for the link. More...
 
readonly int IconIndex
 The resource index within the file specified by IconPath. More...
 

Detailed Description

Represents a shell link targeting a file.

Constructor & Destructor Documentation

◆ ShellLink() [1/2]

NanoByte.Common.Native.WindowsTaskbar.ShellLink.ShellLink ( [Localizable(true)] string  title,
[Localizable(false)] string  path,
[Localizable(false)] string?  arguments = null 
)
inline

Creates a new shell link structure.

Parameters
titleThe title/name of the task link.
pathThe target path the link shall point to and to get the icon from.
argumentsAdditional arguments for title ; can be null.

◆ ShellLink() [2/2]

NanoByte.Common.Native.WindowsTaskbar.ShellLink.ShellLink ( [Localizable(true)] string  title,
[Localizable(false)] string  path,
[Localizable(false)] string  arguments,
[Localizable(false)] string  iconPath,
int  iconIndex 
)
inline

Creates a new shell link structure

Parameters
titleThe title/name of the task link.
pathThe target path the link shall point to.
argumentsAdditional arguments for title ; can be null.
iconPathThe path of the icon for the link.
iconIndexThe resource index within the file specified by iconPath .

Member Data Documentation

◆ Arguments

readonly? string NanoByte.Common.Native.WindowsTaskbar.ShellLink.Arguments

Additional arguments for Title; can be null.

◆ IconIndex

readonly int NanoByte.Common.Native.WindowsTaskbar.ShellLink.IconIndex

The resource index within the file specified by IconPath.

◆ IconPath

readonly string NanoByte.Common.Native.WindowsTaskbar.ShellLink.IconPath

The path of the icon for the link.

◆ Path

readonly string NanoByte.Common.Native.WindowsTaskbar.ShellLink.Path

The target path the link shall point to.

◆ Title

readonly string NanoByte.Common.Native.WindowsTaskbar.ShellLink.Title

The title/name of the task link.


The documentation for this struct was generated from the following file: