Word.LinkFormat class
Represents the linking characteristics for an OLE object or picture.
- Extends
Remarks
Properties
| context | The request context associated with the object. This connects the add-in's process to the Office host application's process. |
| 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. |
Methods
| break |
Breaks the link between the source file and the OLE object, picture, or linked field. |
| load(options) | Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| set(properties, options) | Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. |
| set(properties) | Sets multiple properties on the object at the same time, based on an existing loaded object. |
| toJSON() | Overrides the JavaScript |
| track() | Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you're using this object across |
| untrack() | Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call |
Property Details
context
The request context associated with the object. This connects the add-in's process to the Office host application's process.
context: RequestContext;Property Value
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
isLocked
Specifies if a Field, InlineShape, or Shape object is locked to prevent automatic updating.
isLocked: boolean;Property Value
boolean
Remarks
isPictureSavedWithDocument
Specifies if the linked picture is saved with the document.
isPictureSavedWithDocument: boolean;Property Value
boolean
Remarks
sourceFullName
Specifies the path and name of the source file for the linked OLE object, picture, or field.
sourceFullName: string;Property Value
string
Remarks
sourceName
Gets the name of the source file for the linked OLE object, picture, or field.
readonly sourceName: string;Property Value
string
Remarks
sourcePath
Gets the path of the source file for the linked OLE object, picture, or field.
readonly sourcePath: string;Property Value
string
Remarks
type
Gets the link type.
readonly 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
Method Details
breakLink()
Breaks the link between the source file and the OLE object, picture, or linked field.
breakLink(): void;Returns
void
Remarks
load(options)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(options?: Word.Interfaces.LinkFormatLoadOptions): Word.LinkFormat;Parameters
Provides options for which properties of the object to load.
Returns
load(propertyNames)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNames?: string | string[]): Word.LinkFormat;Parameters
- propertyNames
-
string | string[]
A comma-delimited string or an array of strings that specify the properties to load.
Returns
load(propertyNamesAndPaths)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Word.LinkFormat;Parameters
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.
Returns
set(properties, options)
Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
set(properties: Interfaces.LinkFormatUpdateData, options?: OfficeExtension.UpdateOptions): void;Parameters
- properties
- Word.Interfaces.LinkFormatUpdateData
A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
- options
- OfficeExtension.UpdateOptions
Provides an option to suppress errors if the properties object tries to set any read-only properties.
Returns
void
set(properties)
Sets multiple properties on the object at the same time, based on an existing loaded object.
set(properties: Word.LinkFormat): void;Parameters
- properties
- Word.LinkFormat
Returns
void
toJSON()
Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that's passed to it.) Whereas the original Word.LinkFormat object is an API object, the toJSON method returns a plain JavaScript object (typed as Word.Interfaces.LinkFormatData) that contains shallow copies of any loaded child properties from the original object.
toJSON(): Word.Interfaces.LinkFormatData;Returns
track()
Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you're using this object across .sync calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
track(): Word.LinkFormat;Returns
untrack()
Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call context.sync() before the memory release takes effect.
untrack(): Word.LinkFormat;