Word.Interfaces.LinkFormatData interface
An interface describing the data returned by calling linkFormat.toJSON().
Properties
| is |
Specifies if the link is updated automatically when the container file is opened or when the source file is changed. |
| is |
Specifies if a |
| is |
Specifies if the linked picture is saved with the document. |
| source |
Specifies the path and name of the source file for the linked OLE object, picture, or field. |
| source |
Gets the name of the source file for the linked OLE object, picture, or field. |
| source |
Gets the path of the source file for the linked OLE object, picture, or field. |
| type | Gets the link type. |
Property Details
isAutoUpdated
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 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
isLocked
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 if a Field, InlineShape, or Shape object is locked to prevent automatic updating.
isLocked?: boolean;Property Value
boolean
Remarks
isPictureSavedWithDocument
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 if the linked picture is saved with the document.
isPictureSavedWithDocument?: boolean;Property Value
boolean
Remarks
sourceFullName
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 path and name of the source file for the linked OLE object, picture, or field.
sourceFullName?: string;Property Value
string
Remarks
sourceName
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 name of the source file for the linked OLE object, picture, or field.
sourceName?: string;Property Value
string
Remarks
sourcePath
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 source file for the linked OLE object, picture, or field.
sourcePath?: string;Property Value
string
Remarks
type
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 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"