Word.Interfaces.HyperlinkUpdateData interface
An interface for updating data on the Hyperlink object, for use in hyperlink.set({ ... }).
Properties
| address | Specifies the address (for example, a file name or URL) of the hyperlink. |
| email |
Specifies the text string for the hyperlink's subject line. |
| range | Returns a |
| screen |
Specifies the text that appears as a ScreenTip when the mouse pointer is positioned over the hyperlink. |
| sub |
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. |
| text |
Specifies the hyperlink's visible text in the document. |
Property Details
address
Specifies the address (for example, a file name or URL) of the hyperlink.
address?: string;Property Value
string
Remarks
emailSubject
Specifies the text string for the hyperlink's subject line.
emailSubject?: string;Property Value
string
Remarks
range
Returns a Range object that represents the portion of the document that's contained within the hyperlink.
range?: Word.Interfaces.RangeUpdateData;Property Value
Remarks
screenTip
Specifies the text that appears as a ScreenTip when the mouse pointer is positioned over the hyperlink.
screenTip?: string;Property Value
string
Remarks
subAddress
Specifies a named location in the destination of the hyperlink.
subAddress?: string;Property Value
string
Remarks
target
Specifies the name of the frame or window in which to load the hyperlink.
target?: string;Property Value
string
Remarks
textToDisplay
Specifies the hyperlink's visible text in the document.
textToDisplay?: string;Property Value
string