Word.Frame class

返回一个 BorderUniversalCollection 对象，该对象表示框架的所有边框。

readonly borders: Word.BorderUniversalCollection;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

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

context: RequestContext;

属性值

指定框架的高度 () 磅。

height: number;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

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

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

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

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

horizontalDistanceFromText: number;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

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

horizontalPosition: number;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

指定帧是否锁定。

lockAnchor: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

返回一个 Range 对象，该对象表示框架中包含的文档部分。

readonly range: Word.Range;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

指定帧的相对水平位置。

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

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

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

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

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

返回一个 ShadingUniversal 对象，该对象引用框架的底纹格式。

readonly shading: Word.ShadingUniversal;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

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

textWrap: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

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

verticalDistanceFromText: number;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

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

verticalPosition: number;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

指定框架的宽度 (（以磅) 为单位）。

width: number;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

指定用于确定框架宽度的规则。

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

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

将帧复制到剪贴板。

copy(): void;

返回

注解

[ API 集：WordApiDesktop 1.3 ]

从文档中删除框架并将其放在剪贴板上。

cut(): void;

返回

注解

[ API 集：WordApiDesktop 1.3 ]

删除框架。

delete(): void;

返回

注解

[ API 集：WordApiDesktop 1.3 ]

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

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

参数

返回

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

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

参数

返回

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

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

参数

返回

选择框架。

select(): void;

返回

注解

[ API 集：WordApiDesktop 1.3 ]

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

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

参数

返回

基于现有的已加载对象，同时对对象设置多个属性。

set(properties: Word.Frame): void;

参数

返回

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

toJSON(): Word.Interfaces.FrameData;

返回

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

track(): Word.Frame;

返回

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

untrack(): Word.Frame;

返回