Help2.DisplayTopicFromURL Method (String)

Article
07/11/2012

Displays a Help topic specified by the URL in Document Explorer.

Namespace: Microsoft.VisualStudio.VSHelp80
Assembly: Microsoft.VisualStudio.VSHelp80 (in Microsoft.VisualStudio.VSHelp80.dll)

Syntax

'Declaration
Sub DisplayTopicFromURL ( _
    pszURL As String _
)

void DisplayTopicFromURL(
    string pszURL
)

void DisplayTopicFromURL(
    [InAttribute] String^ pszURL
)

abstract DisplayTopicFromURL : 
        pszURL:string -> unit

function DisplayTopicFromURL(
    pszURL : String
)

Parameters

pszURL
Type: System.String

String containing an URL address that is compatible with Internet Explorer.

Implements

Help.DisplayTopicFromURL(String)

Remarks

DisplayTopicFromURL opens Document Explorer if it is not open already.

Examples

Create a Visual Studio add-in by using Visual C# as described in How to: Create an Add-In. Add references to Microsoft.VisualStudio.VSHelp, Microsoft.VisualStudio.VSHelp80, and System.Windows.Forms. Replace the code in the OnConnection method in the Connect.cs file with the following code. Run the code example as described in How to: Compile and Run the Automation Object Model Code Examples.

using System;
using Extensibility;
using EnvDTE;
using EnvDTE80;
using Microsoft.VisualStudio.VSHelp;
using Microsoft.VisualStudio.VSHelp80;
using System.Windows.Forms;

public void OnConnection(object application,
ext_ConnectMode connectMode, object addInInst, ref Array custom)
{
    _applicationObject = (DTE2)application;
    _addInInstance = (AddIn)addInInst;
    HelpDisplayFromURLExample(_applicationObject);
}

public void HelpDisplayFromURLExample(DTE2 dte)
{
    // This opens Document Explorer and 
    // displays the topic specified
    // by the URL.
    try
    {
        Microsoft.VisualStudio.VSHelp80.Help2 help2 =
(Microsoft.VisualStudio.VSHelp80.Help2)_applicationObject.GetObject 
("Help2");

        // Display the Visual Studio topic.
        help2.DisplayTopicFromURL
("ms-help:
//MS.VSCC.v80/MS.MSDN.v80/MS.VisualStudio.v80.en/dv_vstoc/
html/06ddebea-2c83-4a45-bb48-6264c797ed93.htm");

    }
    catch (SystemException ex)
    {
        MessageBox.Show("ERROR: " + ex);
    }
}

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Share via