Word.OleFormat class
代表 OLE 对象、ActiveX 控件或域的 OLE（而不是链接）特性。
属性
| class |
指定指定 OLE 对象、图片或字段的类类型。 |
| context | 与对象关联的请求上下文。 这将加载项的进程连接到 Office 主机应用程序的进程。 |
| icon |
指定当属性为 |
| icon |
指定在 OLE 对象图标下方显示的文本。 |
| icon |
指定在其中存储 OLE 对象图标的程序文件。 |
| icon |
获取存储 OLE 对象图标的文件的路径。 |
| is |
获取指定对象是否显示为图标。 |
| is |
指定是否保留在 Microsoft Word 中为链接的 OLE 对象所做的格式设置。 |
| label | 获取一个字符串，用于标识源文件中要链接的部分。 |
| prog |
获取指定 OLE 对象的编程标识符 ( |
方法
| activate() | 激活 |
| activate |
设置确定用于激活指定 OLE 对象的默认应用程序的 Windows 注册表值。 |
| do |
请求 OLE 对象执行其可用的谓词之一。 |
| do |
请求 OLE 对象执行其可用的谓词之一。 |
| edit() | 打开 OLE 对象，以便在其中创建该对象的应用程序中进行编辑。 |
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| open() | 打开 |
| set(properties, options) | 同时设置对象的多个属性。 可以传递具有相应属性的纯文本对象，也可以传递另一个相同类型的 API 对象。 |
| set(properties) | 基于现有加载的对象，同时在对象上设置多个属性。 |
| toJSON() | 覆盖 JavaScript |
| track() | 根据文档中的相应更改来跟踪对象，以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果在调用中 |
| untrack() | 释放与此对象关联的内存（如果先前已跟踪过）。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。 需要在内存释放生效之前调用 |
属性详细信息
classType
context
iconIndex
iconLabel
iconName
iconPath
isDisplayedAsIcon
isFormattingPreservedOnUpdate
指定是否保留在 Microsoft Word 中为链接的 OLE 对象所做的格式设置。
isFormattingPreservedOnUpdate: boolean;属性值
boolean
注解
label
progId
方法详细信息
activate()
activateAs(classType)
设置确定用于激活指定 OLE 对象的默认应用程序的 Windows 注册表值。
activateAs(classType: string): void;参数
- classType
-
string
要激活的类类型。
返回
void
注解
doVerb(verbIndex)
请求 OLE 对象执行其可用的谓词之一。
doVerb(verbIndex: Word.OleVerb): void;参数
- verbIndex
- Word.OleVerb
可选。 要执行的谓词的索引。
返回
void
注解
doVerb(verbIndex)
请求 OLE 对象执行其可用的谓词之一。
doVerb(verbIndex: "Primary" | "Show" | "Open" | "Hide" | "UiActivate" | "InPlaceActivate" | "DiscardUndoState"): void;参数
- verbIndex
-
"Primary" | "Show" | "Open" | "Hide" | "UiActivate" | "InPlaceActivate" | "DiscardUndoState"
可选。 要执行的谓词的索引。
返回
void
注解
edit()
load(options)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(options?: Word.Interfaces.OleFormatLoadOptions): Word.OleFormat;参数
为要加载的对象属性提供选项。
返回
load(propertyNames)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames?: string | string[]): Word.OleFormat;参数
- propertyNames
-
string | string[]
指定要加载的属性的逗号分隔的字符串或字符串数组。
返回
load(propertyNamesAndPaths)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Word.OleFormat;参数
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select 是指定要加载的属性的逗号分隔字符串，以及 propertyNamesAndPaths.expand 指定要加载的导航属性的逗号分隔字符串。
返回
open()
set(properties, options)
同时设置对象的多个属性。 可以传递具有相应属性的纯文本对象，也可以传递另一个相同类型的 API 对象。
set(properties: Interfaces.OleFormatUpdateData, options?: OfficeExtension.UpdateOptions): void;参数
- properties
- Word.Interfaces.OleFormatUpdateData
一个 JavaScript 对象，其属性与调用该方法的对象的属性同构结构。
- options
- OfficeExtension.UpdateOptions
提供一个选项，用于在 properties 对象尝试设置任何只读属性时禁止错误。
返回
void
set(properties)
toJSON()
覆盖 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 Word.OleFormat 对象是 API 对象， toJSON 但该方法返回一个纯 JavaScript 对象， (类型化为 Word.Interfaces.OleFormatData) ，其中包含从原始对象加载的任何子属性的浅层副本。
toJSON(): Word.Interfaces.OleFormatData;返回
track()
根据文档中的相应更改来跟踪对象，以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果在调用中 .sync 使用此对象，并且在“.run”批处理的顺序执行之外使用此对象，并且在设置属性或对对象调用方法时收到“InvalidObjectPath”错误，则需要在首次创建对象时将对象添加到跟踪对象集合。 如果此对象是集合的一部分，您还应跟踪父集合。
track(): Word.OleFormat;返回
untrack()
释放与此对象关联的内存（如果先前已跟踪过）。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。 需要在内存释放生效之前调用 context.sync() 。
untrack(): Word.OleFormat;