FollowHyperlink Method

Applies To

Document object.

Description

Displays a cached document, if it's already been downloaded. Otherwise, this method resolves the hyperlink, downloads the target document, and displays the document in the appropriate application.

Note If the hyperlink uses the file protocol, this method opens the document instead of downloading it.

Syntax

expression.FollowHyperlink(Address, SubAddress, NewWindow, AddHistory, ExtraInfo,
ú Method, HeaderInfo)

expression Required. An expression that returns a Document object.

Address Required String. The address of the target document.

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

NewWindow Optional Variant. True to display the target location in a new window. The default value is False.

AddHistory Optional Variant. This argument is reserved for future use.

ExtraInfo Optional Variant. 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 Optional Variant. Specifies the way additional information for HTTP is handled. Can be one of the following MsoExtraInfoMethod constants.

Constant

Description

msoMethodGet

ExtraInfo is a string that's appended to the address.

msoMethodPost

ExtraInfo is posted as a string or a byte array.


HeaderInfo Optional Variant. A string that specifies header information for the HTTP request. The default value is an empty string. 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 may overwrite default HTTP header fields.

See Also

ExtraInfoRequired property, Follow method, Reload method.

Example

This example follows the specified URL address and displays the Microsoft home page in a new window.

ActiveDocument.FollowHyperlink Address:="http://www.microsoft.com", _
    NewWindow:=True, AddHistory:=True
This example displays the HTML document named "Default.htm."

ActiveDocument.FollowHyperlink Address:="file:C:\Pages\Default.htm"