Edit

Share via

Word.Interfaces.OleFormatUpdateData interface

Package:
word

An interface for updating data on the OleFormat object, for use in oleFormat.set({ ... }).

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

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

Property Details

classType

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

classType?: string;

Property Value

string

Remarks

[ API set: WordApiDesktop 1.4 ]

iconIndex

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

iconIndex?: number;

Property Value

number

Remarks

[ API set: WordApiDesktop 1.4 ]

iconLabel

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

iconLabel?: string;

Property Value

string

Remarks

[ API set: WordApiDesktop 1.4 ]

iconName

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

iconName?: string;

Property Value

string

Remarks

[ API set: WordApiDesktop 1.4 ]

isFormattingPreservedOnUpdate

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

isFormattingPreservedOnUpdate?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]