Edit

Share via

Word.HyperlinkAddOptions 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.

Specifies the options for adding to a Word.HyperlinkCollection object.

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Properties

address

If provided, specifies the address (e.g., URL or file path) of the hyperlink.
screenTip

If provided, specifies the text that appears as a tooltip.
subAddress

If provided, specifies the location within the file or document.
target

If provided, specifies the name of the frame or window in which to load the hyperlink.
textToDisplay

If provided, specifies the visible text of the hyperlink.

Property Details

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 address (e.g., URL or file path) of the hyperlink.

address?: string;

Property Value

string

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

screenTip

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 text that appears as a tooltip.

screenTip?: string;

Property Value

string

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 location within the file or document.

subAddress?: string;

Property Value

string

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

target

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 name of the frame or window in which to load the hyperlink.

target?: string;

Property Value

string

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

textToDisplay

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 visible text of the hyperlink.

textToDisplay?: string;

Property Value

string

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]