Edit

Share via

Word.Interfaces.OleFormatData interface

Package:
word

An interface describing the data returned by calling oleFormat.toJSON().

Properties

classType

Specifies the class type for the specified OLE object, picture, or field.
iconIndex

Specifies the icon that is used when the displayAsIcon property is true.
iconLabel

Specifies the text displayed below the icon for the OLE object.
iconName

Specifies the program file in which the icon for the OLE object is stored.
iconPath

Gets the path of the file in which the icon for the OLE object is stored.
isDisplayedAsIcon

Gets whether the specified object is displayed as an icon.
isFormattingPreservedOnUpdate

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.
progID

Gets the programmatic identifier (ProgId) for the specified OLE object.

Property Details

classType

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Specifies the class type for the specified OLE object, picture, or field.

classType?: string;

Property Value

string

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

iconIndex

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Specifies the icon that is used when the displayAsIcon property is true.

iconIndex?: number;

Property Value

number

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

iconLabel

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Specifies the text displayed below the icon for the OLE object.

iconLabel?: string;

Property Value

string

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

iconName

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Specifies the program file in which the icon for the OLE object is stored.

iconName?: string;

Property Value

string

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

iconPath

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Gets the path of the file in which the icon for the OLE object is stored.

iconPath?: string;

Property Value

string

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

isDisplayedAsIcon

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Gets whether the specified object is displayed as an icon.

isDisplayedAsIcon?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

isFormattingPreservedOnUpdate

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Specifies whether formatting done in Microsoft Word to the linked OLE object is preserved.

isFormattingPreservedOnUpdate?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

label

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Gets a string that's used to identify the portion of the source file that's being linked.

label?: string;

Property Value

string

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

progID

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Gets the programmatic identifier (ProgId) for the specified OLE object.

progID?: string;

Property Value

string

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]