Edit

Share via

Word.Interfaces.HyperlinkData interface

Package:
word

An interface describing the data returned by calling hyperlink.toJSON().

Properties

address

Specifies the address (for example, a file name or URL) of the hyperlink.
emailSubject

Specifies the text string for the hyperlink's subject line.
isExtraInfoRequired

Returns true if extra information is required to resolve the hyperlink.
name

Returns the name of the Hyperlink object.
range

Returns a Range object that represents the portion of the document that's contained within the hyperlink.
screenTip

Specifies the text that appears as a ScreenTip when the mouse pointer is positioned over the hyperlink.
subAddress

Specifies a named location in the destination of the hyperlink.
target

Specifies the name of the frame or window in which to load the hyperlink.
textToDisplay

Specifies the hyperlink's visible text in the document.
type

Returns the hyperlink type.

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.

Specifies the address (for example, a file name or URL) of the hyperlink.

address?: string;

Property Value

string

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

emailSubject

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 text string for the hyperlink's subject line.

emailSubject?: string;

Property Value

string

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

isExtraInfoRequired

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.

Returns true if extra information is required to resolve the hyperlink.

isExtraInfoRequired?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

name

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.

Returns the name of the Hyperlink object.

name?: string;

Property Value

string

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

range

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.

Returns a Range object that represents the portion of the document that's contained within the hyperlink.

range?: Word.Interfaces.RangeData;

Property Value

Word.Interfaces.RangeData

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.

Specifies the text that appears as a ScreenTip when the mouse pointer is positioned over the hyperlink.

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.

Specifies a named location in the destination of the hyperlink.

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.

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.

Specifies the hyperlink's visible text in the document.

textToDisplay?: string;

Property Value

string

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

type

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.

Returns the hyperlink type.

type?: Word.HyperlinkType | "Range" | "Shape" | "InlineShape";

Property Value

Word.HyperlinkType | "Range" | "Shape" | "InlineShape"

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]