Edit

Share via


PowerPoint.Interfaces.HyperlinkData interface

An interface describing the data returned by calling hyperlink.toJSON().

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 mailto URI scheme.

screenTip

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.

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

[ API set: PowerPointApi 1.6 ]

screenTip

Specifies the string displayed when hovering over the hyperlink.

screenTip?: string;

Property Value

string

Remarks

[ API set: PowerPointApi 1.6 ]

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.

type?: PowerPoint.HyperlinkType | "TextRange" | "Shape";

Property Value

PowerPoint.HyperlinkType | "TextRange" | "Shape"

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]