Word.DocumentFollowHyperlinkOptions interface

注意

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

提供 Document.followHyperlink 方法的配置选项。

注解

[ API 集:WordApi BETA (仅预览版) ]

属性

addHistory

如果提供,则指定是否将链接添加到浏览历史记录。 默认值 true为 。

address

如果提供,则指定要遵循的超链接地址。 默认值为空字符串。

extraInfo

如果提供,则指定要随请求一起传递的其他信息。 默认值为空字符串。

headerInfo

如果提供,则指定 HTTP 请求的标头信息。 默认值为空字符串。

httpMethod

如果提供,则指定用于请求的 HTTP 方法。 默认值为“GET”。

newWindow

如果提供,则指定是否在新窗口中打开链接。 默认值 false为 。

subAddress

如果提供,则指定文档中的子地址。 默认值为空字符串。

属性详细信息

addHistory

注意

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

如果提供,则指定是否将链接添加到浏览历史记录。 默认值 true为 。

addHistory?: boolean;

属性值

boolean

注解

[ API 集:WordApi BETA (仅预览版) ]

address

注意

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

如果提供,则指定要遵循的超链接地址。 默认值为空字符串。

address?: string;

属性值

string

注解

[ API 集:WordApi BETA (仅预览版) ]

extraInfo

注意

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

如果提供,则指定要随请求一起传递的其他信息。 默认值为空字符串。

extraInfo?: string;

属性值

string

注解

[ API 集:WordApi BETA (仅预览版) ]

headerInfo

注意

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

如果提供,则指定 HTTP 请求的标头信息。 默认值为空字符串。

headerInfo?: string;

属性值

string

注解

[ API 集:WordApi BETA (仅预览版) ]

httpMethod

注意

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

如果提供,则指定用于请求的 HTTP 方法。 默认值为“GET”。

httpMethod?: string;

属性值

string

注解

[ API 集:WordApi BETA (仅预览版) ]

newWindow

注意

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

如果提供,则指定是否在新窗口中打开链接。 默认值 false为 。

newWindow?: boolean;

属性值

boolean

注解

[ API 集:WordApi BETA (仅预览版) ]

subAddress

注意

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

如果提供,则指定文档中的子地址。 默认值为空字符串。

subAddress?: string;

属性值

string

注解

[ API 集:WordApi BETA (仅预览版) ]