Edit

Share via


Word.Interfaces.LinkFormatData interface

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

Properties

isAutoUpdated

Specifies if the link is updated automatically when the container file is opened or when the source file is changed.

isLocked

Specifies if a Field, InlineShape, or Shape object is locked to prevent automatic updating.

isPictureSavedWithDocument

Specifies if the linked picture is saved with the document.

sourceFullName

Specifies the path and name of the source file for the linked OLE object, picture, or field.

sourceName

Gets the name of the source file for the linked OLE object, picture, or field.

sourcePath

Gets the path of the source file for the linked OLE object, picture, or field.

type

Gets the link type.

Property Details

isAutoUpdated

Specifies if the link is updated automatically when the container file is opened or when the source file is changed.

isAutoUpdated?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]

isLocked

Specifies if a Field, InlineShape, or Shape object is locked to prevent automatic updating.

isLocked?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]

isPictureSavedWithDocument

Specifies if the linked picture is saved with the document.

isPictureSavedWithDocument?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]

sourceFullName

Specifies the path and name of the source file for the linked OLE object, picture, or field.

sourceFullName?: string;

Property Value

string

Remarks

[ API set: WordApiDesktop 1.4 ]

sourceName

Gets the name of the source file for the linked OLE object, picture, or field.

sourceName?: string;

Property Value

string

Remarks

[ API set: WordApiDesktop 1.4 ]

sourcePath

Gets the path of the source file for the linked OLE object, picture, or field.

sourcePath?: string;

Property Value

string

Remarks

[ API set: WordApiDesktop 1.4 ]

type

Gets the link type.

type?: Word.LinkType | "Ole" | "Picture" | "Text" | "Reference" | "Include" | "Import" | "Dde" | "DdeAuto" | "Chart";

Property Value

Word.LinkType | "Ole" | "Picture" | "Text" | "Reference" | "Include" | "Import" | "Dde" | "DdeAuto" | "Chart"

Remarks

[ API set: WordApiDesktop 1.4 ]