Word.Hyperlink class
Represents a hyperlink in a Word document.
- Extends
Remarks
Properties
| address | Specifies the address (for example, a file name or URL) of the hyperlink. |
| context | The request context associated with the object. This connects the add-in's process to the Office host application's process. |
| email |
Specifies the text string for the hyperlink's subject line. |
| is |
Returns |
| name | Returns the name of the |
| 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. |
| type | Returns the hyperlink type. |
Methods
| add |
Creates a shortcut to the document or hyperlink and adds it to the Favorites folder. |
| create |
Creates a new document linked to the hyperlink. |
| delete() | Deletes the hyperlink. |
| load(options) | Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| set(properties, options) | Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. |
| set(properties) | Sets multiple properties on the object at the same time, based on an existing loaded object. |
| toJSON() | Overrides the JavaScript |
| track() | Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you're using this object across |
| untrack() | Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call |
Property Details
address
Specifies the address (for example, a file name or URL) of the hyperlink.
address: string;Property Value
string
Remarks
context
The request context associated with the object. This connects the add-in's process to the Office host application's process.
context: RequestContext;Property Value
emailSubject
Specifies the text string for the hyperlink's subject line.
emailSubject: string;Property Value
string
Remarks
isExtraInfoRequired
Returns true if extra information is required to resolve the hyperlink.
readonly isExtraInfoRequired: boolean;Property Value
boolean
Remarks
name
Returns the name of the Hyperlink object.
readonly name: string;Property Value
string
Remarks
range
Returns a Range object that represents the portion of the document that's contained within the hyperlink.
readonly range: Word.Range;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
Remarks
type
Returns the hyperlink type.
readonly type: Word.HyperlinkType | "Range" | "Shape" | "InlineShape";Property Value
Word.HyperlinkType | "Range" | "Shape" | "InlineShape"
Remarks
Method Details
addToFavorites()
Creates a shortcut to the document or hyperlink and adds it to the Favorites folder.
addToFavorites(): void;Returns
void
Remarks
createNewDocument(fileName, editNow, overwrite)
Creates a new document linked to the hyperlink.
createNewDocument(fileName: string, editNow: boolean, overwrite: boolean): void;Parameters
- fileName
-
string
Required. The name of the file.
- editNow
-
boolean
Required. true to start editing now.
- overwrite
-
boolean
Required. true to overwrite if there's another file with the same name.
Returns
void
Remarks
delete()
load(options)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(options?: Word.Interfaces.HyperlinkLoadOptions): Word.Hyperlink;Parameters
Provides options for which properties of the object to load.
Returns
load(propertyNames)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNames?: string | string[]): Word.Hyperlink;Parameters
- propertyNames
-
string | string[]
A comma-delimited string or an array of strings that specify the properties to load.
Returns
load(propertyNamesAndPaths)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Word.Hyperlink;Parameters
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.
Returns
set(properties, options)
Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
set(properties: Interfaces.HyperlinkUpdateData, options?: OfficeExtension.UpdateOptions): void;Parameters
- properties
- Word.Interfaces.HyperlinkUpdateData
A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
- options
- OfficeExtension.UpdateOptions
Provides an option to suppress errors if the properties object tries to set any read-only properties.
Returns
void
set(properties)
Sets multiple properties on the object at the same time, based on an existing loaded object.
set(properties: Word.Hyperlink): void;Parameters
- properties
- Word.Hyperlink
Returns
void
toJSON()
Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that's passed to it.) Whereas the original Word.Hyperlink object is an API object, the toJSON method returns a plain JavaScript object (typed as Word.Interfaces.HyperlinkData) that contains shallow copies of any loaded child properties from the original object.
toJSON(): Word.Interfaces.HyperlinkData;Returns
track()
Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you're using this object across .sync calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
track(): Word.Hyperlink;Returns
untrack()
Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call context.sync() before the memory release takes effect.
untrack(): Word.Hyperlink;