PowerPoint.HyperlinkCollection class
Represents a collection of hyperlinks.
- 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
| context | The request context associated with the object. This connects the add-in's process to the Office host application's process. |
| items | Gets the loaded child items in this collection. |
Methods
| add(target, options) | Adds a hyperlink to the specified target with the given options. If the target already contains any hyperlinks, they will be deleted. The new hyperlink may appear anywhere in the collection and is not guaranteed to be added at the end. |
| get |
Gets the number of hyperlinks in the collection. |
| get |
Gets a hyperlink using its zero-based index in the collection. An error is thrown if the index is out of range. Throws an |
| 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
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
items
Gets the loaded child items in this collection.
readonly items: PowerPoint.Hyperlink[];Property Value
Method Details
add(target, options)
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.
Adds a hyperlink to the specified target with the given options. If the target already contains any hyperlinks, they will be deleted. The new hyperlink may appear anywhere in the collection and is not guaranteed to be added at the end.
add(target: TextRange | Shape, options?: PowerPoint.HyperlinkAddOptions): PowerPoint.Hyperlink;Parameters
- target
The target to add the hyperlink to. Can be a PowerPoint.TextRange or a PowerPoint.Shape.
- options
- PowerPoint.HyperlinkAddOptions
Optional. The options for the hyperlink.
Returns
The newly created PowerPoint.Hyperlink object.
Remarks
getCount()
Gets the number of hyperlinks in the collection.
getCount(): OfficeExtension.ClientResult<number>;Returns
OfficeExtension.ClientResult<number>
The number of hyperlinks in the collection.
Remarks
getItemAt(index)
Gets a hyperlink using its zero-based index in the collection. An error is thrown if the index is out of range. Throws an InvalidArgument exception when the index is out of range.
getItemAt(index: number): PowerPoint.Hyperlink;Parameters
- index
-
number
The index of the hyperlink in the collection.
Returns
The hyperlink at the given index.
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.HyperlinkCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.HyperlinkCollection;Parameters
- options
-
PowerPoint.Interfaces.HyperlinkCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions
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.HyperlinkCollection;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?: OfficeExtension.LoadOption): PowerPoint.HyperlinkCollection;Parameters
- propertyNamesAndPaths
- OfficeExtension.LoadOption
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.HyperlinkCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as PowerPoint.Interfaces.HyperlinkCollectionData) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
toJSON(): PowerPoint.Interfaces.HyperlinkCollectionData;