Word.OleFormat class
Represents the OLE characteristics (other than linking) for an OLE object, ActiveX control, or field.
- Extends
Remarks
Properties
| class |
Specifies the class type for the specified OLE object, picture, or field. |
| context | The request context associated with the object. This connects the add-in's process to the Office host application's process. |
| icon |
Specifies the icon that is used when the |
| icon |
Specifies the text displayed below the icon for the OLE object. |
| icon |
Specifies the program file in which the icon for the OLE object is stored. |
| icon |
Gets the path of the file in which the icon for the OLE object is stored. |
| is |
Gets whether the specified object is displayed as an icon. |
| is |
Specifies whether formatting done in Microsoft Word to the linked OLE object is preserved. |
| label | Gets a string that's used to identify the portion of the source file that's being linked. |
| prog |
Gets the programmatic identifier ( |
Methods
| activate() | Activates the |
| activate |
Sets the Windows registry value that determines the default application used to activate the specified OLE object. |
| do |
Requests that the OLE object perform one of its available verbs. |
| do |
Requests that the OLE object perform one of its available verbs. |
| edit() | Opens the OLE object for editing in the application it was created in. |
| load(options) | Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| open() | Opens the |
| set(properties, options) | Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. |
| set(properties) | Sets multiple properties on the object at the same time, based on an existing loaded object. |
| toJSON() | Overrides the JavaScript |
| track() | Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you're using this object across |
| untrack() | Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call |
Property Details
classType
Specifies the class type for the specified OLE object, picture, or field.
classType: string;Property Value
string
Remarks
context
The request context associated with the object. This connects the add-in's process to the Office host application's process.
context: RequestContext;Property Value
iconIndex
Specifies the icon that is used when the displayAsIcon property is true.
iconIndex: number;Property Value
number
Remarks
iconLabel
Specifies the text displayed below the icon for the OLE object.
iconLabel: string;Property Value
string
Remarks
iconName
Specifies the program file in which the icon for the OLE object is stored.
iconName: string;Property Value
string
Remarks
iconPath
Gets the path of the file in which the icon for the OLE object is stored.
readonly iconPath: string;Property Value
string
Remarks
isDisplayedAsIcon
Gets whether the specified object is displayed as an icon.
readonly isDisplayedAsIcon: boolean;Property Value
boolean
Remarks
isFormattingPreservedOnUpdate
Specifies whether formatting done in Microsoft Word to the linked OLE object is preserved.
isFormattingPreservedOnUpdate: boolean;Property Value
boolean
Remarks
label
Gets a string that's used to identify the portion of the source file that's being linked.
readonly label: string;Property Value
string
Remarks
progId
Gets the programmatic identifier (ProgId) for the specified OLE object.
readonly progId: string;Property Value
string
Remarks
Method Details
activate()
Activates the OleFormat object.
activate(): void;Returns
void
Remarks
activateAs(classType)
Sets the Windows registry value that determines the default application used to activate the specified OLE object.
activateAs(classType: string): void;Parameters
- classType
-
string
The class type to activate as.
Returns
void
Remarks
doVerb(verbIndex)
Requests that the OLE object perform one of its available verbs.
doVerb(verbIndex: Word.OleVerb): void;Parameters
- verbIndex
- Word.OleVerb
Optional. The index of the verb to perform.
Returns
void
Remarks
doVerb(verbIndex)
Requests that the OLE object perform one of its available verbs.
doVerb(verbIndex: "Primary" | "Show" | "Open" | "Hide" | "UiActivate" | "InPlaceActivate" | "DiscardUndoState"): void;Parameters
- verbIndex
-
"Primary" | "Show" | "Open" | "Hide" | "UiActivate" | "InPlaceActivate" | "DiscardUndoState"
Optional. The index of the verb to perform.
Returns
void
Remarks
edit()
Opens the OLE object for editing in the application it was created in.
edit(): void;Returns
void
Remarks
load(options)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(options?: Word.Interfaces.OleFormatLoadOptions): Word.OleFormat;Parameters
Provides options for which properties of the object to load.
Returns
load(propertyNames)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNames?: string | string[]): Word.OleFormat;Parameters
- propertyNames
-
string | string[]
A comma-delimited string or an array of strings that specify the properties to load.
Returns
load(propertyNamesAndPaths)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Word.OleFormat;Parameters
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.
Returns
open()
set(properties, options)
Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
set(properties: Interfaces.OleFormatUpdateData, options?: OfficeExtension.UpdateOptions): void;Parameters
- properties
- Word.Interfaces.OleFormatUpdateData
A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
- options
- OfficeExtension.UpdateOptions
Provides an option to suppress errors if the properties object tries to set any read-only properties.
Returns
void
set(properties)
Sets multiple properties on the object at the same time, based on an existing loaded object.
set(properties: Word.OleFormat): void;Parameters
- properties
- Word.OleFormat
Returns
void
toJSON()
Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that's passed to it.) Whereas the original Word.OleFormat object is an API object, the toJSON method returns a plain JavaScript object (typed as Word.Interfaces.OleFormatData) that contains shallow copies of any loaded child properties from the original object.
toJSON(): Word.Interfaces.OleFormatData;Returns
track()
Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you're using this object across .sync calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
track(): Word.OleFormat;Returns
untrack()
Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call context.sync() before the memory release takes effect.
untrack(): Word.OleFormat;