PowerPoint.HyperlinkAddOptions interface

Remarks

API set: PowerPointApi 1.10

Used by

• PowerPoint.HyperlinkCollection: add
• PowerPoint.Shape: setHyperlink
• PowerPoint.TextRange: setHyperlink

Examples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/hyperlinks/manage-hyperlinks.yaml

// Sets a hyperlink on the selected text range.
await PowerPoint.run(async (context) => {
 const slide: PowerPoint.Slide = context.presentation.getSelectedSlides().getItemAt(0);
 const textRange: PowerPoint.TextRange = context.presentation.getSelectedTextRange().load("text");
 const hyperlinks: PowerPoint.HyperlinkCollection = slide.hyperlinks;
 const hyperlinkAddOptions: PowerPoint.HyperlinkAddOptions = {
 address: "https://bing.com",
 screenTip: "Screen tip for text",
 };
 let hyperlink: PowerPoint.Hyperlink = hyperlinks.add(textRange, hyperlinkAddOptions).load("address,screenTip");
 try {
 await context.sync();
 } catch {
 console.warn(
 "Confirm that you have at least one slide and you've selected a contiguous range of text on the active slide.",
 );
 return;
 }

 console.log(
 `Added link "${hyperlink.address}" (screen tip: "${hyperlink.screenTip}") to the selected text "${textRange.text}".`,
 );
});

Properties

address

address?: string;

screenTip

screenTip?: string;