Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

Word.Interfaces.OleFormatLoadOptions interface

Package:
word

Represents the OLE characteristics (other than linking) for an OLE object, ActiveX control, or field.

Remarks

API set: WordApiDesktop 1.4

Used by

Properties

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).
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

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).

$all?: boolean;

Property Value

boolean

classType

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

classType?: boolean;

Property Value

boolean

Remarks

API set: WordApiDesktop 1.4

iconIndex

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

iconIndex?: boolean;

Property Value

boolean

Remarks

API set: WordApiDesktop 1.4

iconLabel

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

iconLabel?: boolean;

Property Value

boolean

Remarks

API set: WordApiDesktop 1.4

iconName

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

iconName?: boolean;

Property Value

boolean

Remarks

API set: WordApiDesktop 1.4

iconPath

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

iconPath?: boolean;

Property Value

boolean

Remarks

API set: WordApiDesktop 1.4

isDisplayedAsIcon

Gets whether the specified object is displayed as an icon.

isDisplayedAsIcon?: boolean;

Property Value

boolean

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

label

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

label?: boolean;

Property Value

boolean

Remarks

API set: WordApiDesktop 1.4

progId

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

progId?: boolean;

Property Value

boolean

Remarks

API set: WordApiDesktop 1.4

Feedback

Was this page helpful?