PowerPoint.Hyperlink class
Represents a single hyperlink.
- Extends
Remarks
[ API set: PowerPointApi 1.6 ]
Examples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/hyperlinks/manage-hyperlinks.yaml
// Gets the hyperlinks found in the first selected slide.
await PowerPoint.run(async (context) => {
const slide: PowerPoint.Slide = context.presentation.getSelectedSlides().getItemAt(0);
const hyperlinks: PowerPoint.HyperlinkCollection = slide.hyperlinks.load("address,screenTip");
const hyperlinksCount = hyperlinks.getCount();
await context.sync();
console.log(`${hyperlinksCount.value} hyperlinks found in first selected slide:`);
for (let link of hyperlinks.items) {
console.log(`Address: "${link.address}" (Screen tip: "${link.screenTip}")`);
}
});
Properties
| address | Specifies the address of the hyperlink, which can be a URL, a file name or file path, or an email address with the |
| context | The request context associated with the object. This connects the add-in's process to the Office host application's process. |
| screen |
Specifies the string displayed when hovering over the hyperlink. |
| type | Returns the type of object that the hyperlink is applied to. See PowerPoint.HyperlinkType for details. |
Methods
| delete() | Deletes the hyperlink. |
| get |
Returns the PowerPoint.Shape object that the hyperlink is applied to. If the hyperlink is not of type |
| get |
Returns the PowerPoint.TextRange object that the hyperlink is applied to. If the hyperlink is not of type |
| 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 |
| toJSON() | Overrides the JavaScript |
Property Details
address
Specifies the address of the hyperlink, which can be a URL, a file name or file path, or an email address with the mailto URI scheme.
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
screenTip
Specifies the string displayed when hovering over the hyperlink.
screenTip: string;Property Value
string
Remarks
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 type of object that the hyperlink is applied to. See PowerPoint.HyperlinkType for details.
readonly type: PowerPoint.HyperlinkType | "TextRange" | "Shape";Property Value
PowerPoint.HyperlinkType | "TextRange" | "Shape"
Remarks
Method Details
delete()
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.
Deletes the hyperlink.
delete(): void;Returns
void
Remarks
getLinkedShapeOrNullObject()
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 PowerPoint.Shape object that the hyperlink is applied to. If the hyperlink is not of type shape, or it is within a domain that does not currently support a PowerPoint.Shape, then this method returns an object with its isNullObject property set to true. For further information, see *OrNullObject methods and properties.
getLinkedShapeOrNullObject(): PowerPoint.Shape;Returns
Remarks
getLinkedTextRangeOrNullObject()
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 PowerPoint.TextRange object that the hyperlink is applied to. If the hyperlink is not of type textRange, or it is within a domain that does not currently support a PowerPoint.TextRange, then this method returns an object with its isNullObject property set to true. For further information, see *OrNullObject methods and properties.
getLinkedTextRangeOrNullObject(): PowerPoint.TextRange;Returns
Remarks
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?: PowerPoint.Interfaces.HyperlinkLoadOptions): PowerPoint.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[]): PowerPoint.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;
}): PowerPoint.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
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 PowerPoint.Hyperlink object is an API object, the toJSON method returns a plain JavaScript object (typed as PowerPoint.Interfaces.HyperlinkData) that contains shallow copies of any loaded child properties from the original object.
toJSON(): PowerPoint.Interfaces.HyperlinkData;