DocumentBase.FollowHyperlink Method

Reference

Definition

Namespace:: Microsoft.Office.Tools.Word

Assembly:: Microsoft.Office.Tools.Word.v4.0.Utilities.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Resolves a hyperlink, or displays a cached document if the document has already been downloaded.

public void FollowHyperlink (ref object address, ref object subAddress, ref object newWindow, ref object addHistory, ref object extraInfo, ref object method, ref object headerInfo);

member this.FollowHyperlink : obj * obj * obj * obj * obj * obj * obj -> unit

Public Sub FollowHyperlink (Optional ByRef address As Object, Optional ByRef subAddress As Object, Optional ByRef newWindow As Object, Optional ByRef addHistory As Object, Optional ByRef extraInfo As Object, Optional ByRef method As Object, Optional ByRef headerInfo As Object)

Parameters

address: Object

The address of the target document.

subAddress: Object

The location within the target document. The default value is an empty string.

newWindow: Object

true to display the target location in a new window. The default value is false.

addHistory: Object

true to add the link to the current day's history folder.

extraInfo: Object

A string or a byte array that specifies additional information for HTTP to use to resolve the hyperlink. For example, you can use ExtraInfo to specify the coordinates of an image map, the contents of a form, or a FAT file name. The string is either posted or appended, depending on the value of Method. Use the ExtraInfoRequired property to determine whether extra information is required.

method: Object

Specifies the way additional information for HTTP is handled. MsoExtraInfoMethod.

headerInfo: Object

A string that specifies header information for the HTTP request. The default value is an empty string. In Visual Basic, you can combine several header lines into a single string by using the following syntax: "string1 " & vbCr & "string2 ". The specified string is automatically converted into ANSI characters. Note that the HeaderInfo argument might overwrite default HTTP header fields.

Examples

The following code example uses the FollowHyperlink method to display a Web page in a new window. To use this example, run it from the ThisDocument class in a document-level project.

private void DocumentFollowHyperlink()
{
    object address = "http://www.adatum.com/";
    object newWindow = true;
    object addHistory = false;

    this.FollowHyperlink(ref address, ref missing, ref newWindow,
        ref addHistory, ref missing, ref missing, ref missing);
}

Private Sub DocumentFollowHyperlink()
    Me.FollowHyperlink(Address:="http://www.adatum.com", _
        NewWindow:=True, AddHistory:=False)
End Sub

Remarks

This method displays the cached document located at the Address parameter, if it has already been downloaded. Otherwise, this method resolves the hyperlink, downloads the target document, and displays the document in the appropriate application. If the hyperlink uses the file protocol, this method opens the document instead of downloading it.

Optional Parameters

For information on optional parameters, see Optional Parameters in Office Solutions.

Applies to

Share via