Word.Frame class

表示框架。 该 Frame 对象是 Word.FrameCollection 对象的成员。

扩展

注解

API 集:WordApiDesktop 1.3

使用方

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/35-ranges/inspect-range-layout-desktop.yaml

// Reads the text and dimensions of frames in the document body range.
await Word.run(async (context) => {
    const bodyRange: Word.Range = context.document.body.getRange();
    const frames: Word.FrameCollection = bodyRange.frames;
    frames.load("items/width,items/height,items/range/text");
    await context.sync();
    console.log(`Frames found: ${frames.items.length}`);
    frames.items.forEach((frame: Word.Frame) => {
        console.log({ width: frame.width, height: frame.height, text: frame.range.text });
    });
});

属性

borders

返回 BorderUniversalCollection 表示框架所有边框的对象。

context

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

height

指定高度 (,以帧) 点为单位。

heightRule

指定表示 FrameSizeRule 用于确定框架高度的规则的值。

horizontalDistanceFromText

指定框架与周围文本之间的水平距离(以磅为单位)。

horizontalPosition

指定框架边缘与属性指定的 relativeHorizontalPosition 项目之间的水平距离。

lockAnchor

指定帧是否已锁定。

range

返回表示 Range 帧内包含的文档部分的对象。

relativeHorizontalPosition

指定帧的相对水平位置。

relativeVerticalPosition

指定框架的相对垂直位置。

shading

返回引用 ShadingUniversal 帧的着色格式的对象。

textWrap

指定文档文本是否环绕框架。

verticalDistanceFromText

指定框架与周围文本之间的垂直距离 ((以点) 为单位)。

verticalPosition

指定框架边缘与属性指定的 relativeVerticalPosition 项目之间的垂直距离。

width

指定帧) 点 (的宽度。

widthRule

指定用于确定帧宽度的规则。

方法

copy()

将帧复制到剪贴板。

cut()

从文档中删除框架并将其置于剪贴板中。

delete()

删除帧。

load(options)

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

load(propertyNames)

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

load(propertyNamesAndPaths)

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

select()

选择帧。

set(properties, options)

同时设置对象的多个属性。 可以传递具有相应属性的纯文本对象,也可以传递另一个相同类型的 API 对象。

set(properties)

基于现有加载的对象,同时在对象上设置多个属性。

toJSON()

覆盖 JavaScript toJSON() 方法,以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 Word.Frame 对象是 API 对象, toJSON 但该方法返回一个纯 JavaScript 对象, (类型化为 Word.Interfaces.FrameData) ,其中包含从原始对象加载的任何子属性的浅层副本。

track()

根据文档中的相应更改来跟踪对象,以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果在调用中 .sync 使用此对象,并且在“.run”批处理的顺序执行之外使用此对象,并且在设置属性或对对象调用方法时收到“InvalidObjectPath”错误,则需要在首次创建对象时将对象添加到跟踪对象集合。 如果此对象是集合的一部分,您还应跟踪父集合。

untrack()

释放与此对象关联的内存(如果先前已跟踪过)。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度,因此请在使用完毕后释放所添加的任何对象。 需要在内存释放生效之前调用 context.sync() 。

属性详细信息

borders

返回 BorderUniversalCollection 表示框架所有边框的对象。

readonly borders: Word.BorderUniversalCollection;

属性值

注解

API 集:WordApiDesktop 1.3

context

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

context: RequestContext;

属性值

height

指定高度 (,以帧) 点为单位。

height: number;

属性值

number

注解

API 集:WordApiDesktop 1.3

heightRule

指定表示 FrameSizeRule 用于确定框架高度的规则的值。

heightRule: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact";

属性值

Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"

注解

API 集:WordApiDesktop 1.3

horizontalDistanceFromText

指定框架与周围文本之间的水平距离(以磅为单位)。

horizontalDistanceFromText: number;

属性值

number

注解

API 集:WordApiDesktop 1.3

horizontalPosition

指定框架边缘与属性指定的 relativeHorizontalPosition 项目之间的水平距离。

horizontalPosition: number;

属性值

number

注解

API 集:WordApiDesktop 1.3

lockAnchor

指定帧是否已锁定。

lockAnchor: boolean;

属性值

boolean

注解

API 集:WordApiDesktop 1.3

range

返回表示 Range 帧内包含的文档部分的对象。

readonly range: Word.Range;

属性值

注解

API 集:WordApiDesktop 1.3

relativeHorizontalPosition

指定帧的相对水平位置。

relativeHorizontalPosition: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin";

属性值

Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"

注解

API 集:WordApiDesktop 1.3

relativeVerticalPosition

指定框架的相对垂直位置。

relativeVerticalPosition: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";

属性值

Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"

注解

API 集:WordApiDesktop 1.3

shading

返回引用 ShadingUniversal 帧的着色格式的对象。

readonly shading: Word.ShadingUniversal;

属性值

注解

API 集:WordApiDesktop 1.3

textWrap

指定文档文本是否环绕框架。

textWrap: boolean;

属性值

boolean

注解

API 集:WordApiDesktop 1.3

verticalDistanceFromText

指定框架与周围文本之间的垂直距离 ((以点) 为单位)。

verticalDistanceFromText: number;

属性值

number

注解

API 集:WordApiDesktop 1.3

verticalPosition

指定框架边缘与属性指定的 relativeVerticalPosition 项目之间的垂直距离。

verticalPosition: number;

属性值

number

注解

API 集:WordApiDesktop 1.3

width

指定帧) 点 (的宽度。

width: number;

属性值

number

注解

API 集:WordApiDesktop 1.3

widthRule

指定用于确定帧宽度的规则。

widthRule: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact";

属性值

Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"

注解

API 集:WordApiDesktop 1.3

方法详细信息

copy()

将帧复制到剪贴板。

copy(): void;

返回

void

注解

API 集:WordApiDesktop 1.3

cut()

从文档中删除框架并将其置于剪贴板中。

cut(): void;

返回

void

注解

API 集:WordApiDesktop 1.3

delete()

删除帧。

delete(): void;

返回

void

注解

API 集:WordApiDesktop 1.3

load(options)

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

load(options?: Word.Interfaces.FrameLoadOptions): Word.Frame;

参数

options
Word.Interfaces.FrameLoadOptions

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

返回

load(propertyNames)

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

load(propertyNames?: string | string[]): Word.Frame;

参数

propertyNames

string | string[]

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

返回

load(propertyNamesAndPaths)

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

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.Frame;

参数

propertyNamesAndPaths

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

propertyNamesAndPaths.select 是指定要加载的属性的逗号分隔字符串,以及 propertyNamesAndPaths.expand 指定要加载的导航属性的逗号分隔字符串。

返回

select()

选择帧。

select(): void;

返回

void

注解

API 集:WordApiDesktop 1.3

set(properties, options)

同时设置对象的多个属性。 可以传递具有相应属性的纯文本对象,也可以传递另一个相同类型的 API 对象。

set(properties: Interfaces.FrameUpdateData, options?: OfficeExtension.UpdateOptions): void;

参数

properties
Word.Interfaces.FrameUpdateData

一个 JavaScript 对象,其属性与调用该方法的对象的属性同构结构。

options
OfficeExtension.UpdateOptions

提供一个选项,用于在 properties 对象尝试设置任何只读属性时禁止错误。

返回

void

set(properties)

基于现有加载的对象,同时在对象上设置多个属性。

set(properties: Word.Frame): void;

参数

properties
Word.Frame

返回

void

toJSON()

覆盖 JavaScript toJSON() 方法,以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 Word.Frame 对象是 API 对象, toJSON 但该方法返回一个纯 JavaScript 对象, (类型化为 Word.Interfaces.FrameData) ,其中包含从原始对象加载的任何子属性的浅层副本。

toJSON(): Word.Interfaces.FrameData;

返回

track()

根据文档中的相应更改来跟踪对象,以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果在调用中 .sync 使用此对象,并且在“.run”批处理的顺序执行之外使用此对象,并且在设置属性或对对象调用方法时收到“InvalidObjectPath”错误,则需要在首次创建对象时将对象添加到跟踪对象集合。 如果此对象是集合的一部分,您还应跟踪父集合。

track(): Word.Frame;

返回

untrack()

释放与此对象关联的内存(如果先前已跟踪过)。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度,因此请在使用完毕后释放所添加的任何对象。 需要在内存释放生效之前调用 context.sync() 。

untrack(): Word.Frame;

返回