Edit

Share via

Word.HyperlinkAddOptions interface

Package:
word

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

Remarks

[ API set: WordApiDesktop 1.3 ]

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

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

address?: string;

Property Value

string

Remarks

[ API set: WordApiDesktop 1.3 ]

screenTip

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

screenTip?: string;

Property Value

string

Remarks

[ API set: WordApiDesktop 1.3 ]

subAddress

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

subAddress?: string;

Property Value

string

Remarks

[ API set: WordApiDesktop 1.3 ]

target

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

target?: string;

Property Value

string

Remarks

[ API set: WordApiDesktop 1.3 ]

textToDisplay

If provided, specifies the visible text of the hyperlink.

textToDisplay?: string;

Property Value

string

Remarks

[ API set: WordApiDesktop 1.3 ]