Word.Interfaces.OleFormatData interface
An interface describing the data returned by calling oleFormat.toJSON().
Properties
| class |
Specifies the class type for the specified OLE object, picture, or field. |
| 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 ( |
Property Details
classType
Specifies the class type for the specified OLE object, picture, or field.
classType?: string;
Property Value
string
Remarks
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.
iconPath?: string;
Property Value
string
Remarks
isDisplayedAsIcon
Gets whether the specified object is displayed as an icon.
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.
label?: string;
Property Value
string
Remarks
progId
Gets the programmatic identifier (ProgId) for the specified OLE object.
progId?: string;
Property Value
string