Word.OleFormat class

指定指定 OLE 对象、图片或字段的类类型。

classType: string;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

context: RequestContext;

属性值

指定属性为 true时displayAsIcon使用的图标。

iconIndex: number;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

指定 OLE 对象的图标下方显示的文本。

iconLabel: string;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

指定存储 OLE 对象的图标的程序文件。

iconName: string;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

获取存储 OLE 对象的图标的文件的路径。

readonly iconPath: string;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

获取指定的对象是否显示为图标。

readonly isDisplayedAsIcon: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

指定是否保留对链接 OLE 对象的Microsoft Word中完成的格式设置。

isFormattingPreservedOnUpdate: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

获取用于标识要链接的源文件部分的字符串。

readonly label: string;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

获取指定 OLE 对象的编程标识符 (ProgId) 。

readonly progId: string;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

激活 OleFormat 对象。

activate(): void;

返回

注解

[ API 集：WordApiDesktop 1.4 ]

设置确定用于激活指定 OLE 对象的默认应用程序的 Windows 注册表值。

activateAs(classType: string): void;

参数

返回

注解

[ API 集：WordApiDesktop 1.4 ]

请求 OLE 对象执行其可用谓词之一。

doVerb(verbIndex: Word.OleVerb): void;

参数

返回

注解

[ API 集：WordApiDesktop 1.4 ]

请求 OLE 对象执行其可用谓词之一。

doVerb(verbIndex: "Primary" | "Show" | "Open" | "Hide" | "UiActivate" | "InPlaceActivate" | "DiscardUndoState"): void;

参数

返回

注解

[ API 集：WordApiDesktop 1.4 ]

打开 OLE 对象，以便在创建它的应用程序中进行编辑。

edit(): void;

返回

注解

[ API 集：WordApiDesktop 1.4 ]

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

load(options?: Word.Interfaces.OleFormatLoadOptions): Word.OleFormat;

参数

返回

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

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

参数

返回

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

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

参数

返回

OleFormat打开 对象。

open(): void;

返回

注解

[ API 集：WordApiDesktop 1.4 ]

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

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

参数

返回

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

set(properties: Word.OleFormat): void;

参数

返回

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

toJSON(): Word.Interfaces.OleFormatData;

返回

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

track(): Word.OleFormat;

返回

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

untrack(): Word.OleFormat;

返回