ProvideLanguageServiceAttribute.DefaultToNonHotURLs Property

Definition

Namespace:

Microsoft.VisualStudio.Shell

Assembly:

Microsoft.VisualStudio.Shell.15.0.dll

Package:

Microsoft.VisualStudio.Shell.15.0 v17.12.40392

Determines the initial setting of the Enable single-click URL navigation option in the Options dialog box.

public:
 property bool DefaultToNonHotURLs { bool get(); void set(bool value); };

public:
 property bool DefaultToNonHotURLs { bool get(); void set(bool value); };

public bool DefaultToNonHotURLs { get; set; }

member this.DefaultToNonHotURLs : bool with get, set

Public Property DefaultToNonHotURLs As Boolean

Property Value

Boolean

Returns true if the Enable single-click URL navigation should be turned off; otherwise, returns false, the option is initially turned on.

Examples

[ProvideLanguageService(typeof(MyLanguageService),           // Required  
                        MyConstants.languageName,            // Required  
                        MyConstants.languageNameResourceID,  // Required  
    // Optional language service properties  
    DefaultToNonHotURLs = true,  // Links require ctrl-click to follow  
                       )]  

Remarks

A language service can support URLs in source code. Following HTML conventions, a URL can be clicked once to follow the link. However, in an application such as Visual Studio, it may be better to allow the link to be followed only if the user holds down a key (for example, the Control key) while clicking to follow the link. This helps reduce frustration if the user is simply trying to click in the middle of the link to edit it (otherwise, they must click off of the link and then use the keyboard to move the caret to where they want to edit). The ability to single-click a URL is controlled by the Enable single-click URL navigation option, typically available on the General tab for each language in the Options dialog box (available under Tools -> Options menu).

This property is available to any language service implementation.

The default is false indicating that the Enable single-click URL navigation option should be initially turned off.

The registry entry looks like this:

HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\VisualStudio\[X.Y]\Languages\Language Services\  
  [Language Name]\  
    Default to Non Hot URLs = reg_dword: 0x00000001