Edit

Share via

Word.DocumentFollowHyperlinkOptions interface

Package:
word

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Provides configuration options for the Document.followHyperlink method.

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Properties

addHistory

If provided, specifies whether to add the link to the browsing history. The default value is true.
address

If provided, specifies the hyperlink address to follow. The default value is an empty string.
extraInfo

If provided, specifies additional information to pass with the request. The default value is an empty string.
headerInfo

If provided, specifies header information for the HTTP request. The default value is an empty string.
httpMethod

If provided, specifies the HTTP method to use for the request. The default value is "GET".
newWindow

If provided, specifies whether to open the link in a new window. The default value is false.
subAddress

If provided, specifies the sub-address within the document. The default value is an empty string.

Property Details

addHistory

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

If provided, specifies whether to add the link to the browsing history. The default value is true.

addHistory?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

address

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

If provided, specifies the hyperlink address to follow. The default value is an empty string.

address?: string;

Property Value

string

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

extraInfo

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

If provided, specifies additional information to pass with the request. The default value is an empty string.

extraInfo?: string;

Property Value

string

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

headerInfo

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

If provided, specifies header information for the HTTP request. The default value is an empty string.

headerInfo?: string;

Property Value

string

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

httpMethod

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

If provided, specifies the HTTP method to use for the request. The default value is "GET".

httpMethod?: string;

Property Value

string

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

newWindow

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

If provided, specifies whether to open the link in a new window. The default value is false.

newWindow?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

subAddress

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

If provided, specifies the sub-address within the document. The default value is an empty string.

subAddress?: string;

Property Value

string

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]