Edit

Share via

PowerPoint.Interfaces.HyperlinkCollectionLoadOptions interface

Package:
powerpoint

Represents a collection of hyperlinks.

Remarks

[ API set: PowerPointApi 1.6 ]

Properties

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).
address

For EACH ITEM in the collection: 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

For EACH ITEM in the collection: Specifies the string displayed when hovering over the hyperlink.
type

For EACH ITEM in the collection: Returns the type of object that the hyperlink is applied to. See PowerPoint.HyperlinkType for details.

Property Details

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).

$all?: boolean;

Property Value

boolean

address

For EACH ITEM in the collection: 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?: boolean;

Property Value

boolean

Remarks

[ API set: PowerPointApi 1.6 ]

screenTip

For EACH ITEM in the collection: Specifies the string displayed when hovering over the hyperlink.

screenTip?: boolean;

Property Value

boolean

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.

For EACH ITEM in the collection: Returns the type of object that the hyperlink is applied to. See PowerPoint.HyperlinkType for details.

type?: boolean;

Property Value

boolean

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]