通过

PowerPoint.Hyperlink class

包:
powerpoint

表示单个超链接。

扩展
OfficeExtension.ClientObject

注解

[ API 集：PowerPointApi 1.6 ]

示例

// 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}")`);
  }
});

属性

address

指定超链接的地址，可以是 URL、文件名或文件路径，也可以是具有 mailto URI 方案的电子邮件地址。
context

与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。
screenTip

指定将鼠标悬停在超链接上时显示的字符串。
type

返回超链接应用于的对象的类型。 有关详细信息，请参阅 PowerPoint.HyperlinkType 。

方法

delete()

删除超链接。
getLinkedShapeOrNullObject()

返回超链接应用到的 PowerPoint.Shape 对象。 如果超链接的类型不是 shape，或者它位于当前不支持 PowerPoint.Shape 的域中，则此方法返回对象，其 isNullObject 属性设置为 true。 有关详细信息，请参阅 *OrNullObject 方法和属性。
getLinkedTextRangeOrNullObject()

返回超链接应用到的 PowerPoint.TextRange 对象。 如果超链接的类型 textRange不是 ，或者它位于当前不支持 PowerPoint.TextRange 的域中，则此方法返回一个对象，其 isNullObject 属性设置为 true。 有关详细信息，请参阅 *OrNullObject 方法和属性。
load(options)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
toJSON()

重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，依次调用toJSON传递给它的 对象的 方法。) 虽然原始PowerPoint.Hyperlink对象是 API 对象，toJSON但该方法返回一个纯 JavaScript 对象， (类型为 PowerPoint.Interfaces.HyperlinkData) ，其中包含从原始对象加载的任何子属性的浅表副本。

属性详细信息

指定超链接的地址，可以是 URL、文件名或文件路径，也可以是具有 mailto URI 方案的电子邮件地址。

address: string;

属性值

string

注解

[ API 集：PowerPointApi 1.6 ]

与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。

context: RequestContext;

属性值

PowerPoint.RequestContext

指定将鼠标悬停在超链接上时显示的字符串。

screenTip: string;

属性值

string

注解

[ API 集：PowerPointApi 1.6 ]

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

返回超链接应用于的对象的类型。 有关详细信息，请参阅 PowerPoint.HyperlinkType 。

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

属性值

PowerPoint.HyperlinkType | "TextRange" | "Shape"

注解

[ API 集：PowerPointApi BETA (仅预览版) ]

方法详细信息

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

删除超链接。

delete(): void;

返回

void

注解

[ API 集：PowerPointApi BETA (仅预览版) ]

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

返回超链接应用到的 PowerPoint.Shape 对象。 如果超链接的类型不是 shape，或者它位于当前不支持 PowerPoint.Shape 的域中，则此方法返回对象，其 isNullObject 属性设置为 true。 有关详细信息，请参阅 *OrNullObject 方法和属性。

getLinkedShapeOrNullObject(): PowerPoint.Shape;

返回

PowerPoint.Shape

注解

[ API 集：PowerPointApi BETA (仅预览版) ]

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

返回超链接应用到的 PowerPoint.TextRange 对象。 如果超链接的类型 textRange不是 ，或者它位于当前不支持 PowerPoint.TextRange 的域中，则此方法返回一个对象，其 isNullObject 属性设置为 true。 有关详细信息，请参阅 *OrNullObject 方法和属性。

getLinkedTextRangeOrNullObject(): PowerPoint.TextRange;

返回

PowerPoint.TextRange

注解

[ API 集：PowerPointApi BETA (仅预览版) ]

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

load(options?: PowerPoint.Interfaces.HyperlinkLoadOptions): PowerPoint.Hyperlink;

参数

options
PowerPoint.Interfaces.HyperlinkLoadOptions

提供要加载对象的属性的选项。

返回

PowerPoint.Hyperlink

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

load(propertyNames?: string | string[]): PowerPoint.Hyperlink;

参数

propertyNames

string | string[]

逗号分隔的字符串或指定要加载的属性的字符串数组。

返回

PowerPoint.Hyperlink

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): PowerPoint.Hyperlink;

参数

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select 是一个逗号分隔的字符串，指定要加载的属性，是 propertyNamesAndPaths.expand 一个逗号分隔的字符串，指定要加载的导航属性。

返回

PowerPoint.Hyperlink

重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，依次调用toJSON传递给它的 对象的 方法。) 虽然原始PowerPoint.Hyperlink对象是 API 对象，toJSON但该方法返回一个纯 JavaScript 对象， (类型为 PowerPoint.Interfaces.HyperlinkData) ，其中包含从原始对象加载的任何子属性的浅表副本。

toJSON(): PowerPoint.Interfaces.HyperlinkData;

返回

PowerPoint.Interfaces.HyperlinkData