Word.LinkFormat class
Представляет характеристики связывания для объекта или рисунка OLE.
- Extends
Свойства
| context | Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office. |
| is |
Указывает, обновляется ли ссылка автоматически при открытии файла контейнера или при изменении исходного файла. |
| is |
Указывает, заблокирован ли |
| is |
Указывает, сохраняется ли связанное изображение вместе с документом. |
| source |
Указывает путь и имя исходного файла для связанного объекта OLE, рисунка или поля. |
| source |
Возвращает имя исходного файла для связанного объекта OLE, рисунка или поля. |
| source |
Возвращает путь к исходному файлу для связанного объекта OLE, рисунка или поля. |
| type | Возвращает тип ссылки. |
Методы
| break |
Разрывает связь между исходным файлом и объектом OLE, рисунком или связанным полем. |
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| set(properties, options) | Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа. |
| set(properties) | Задает несколько свойств объекта одновременно на основе существующего загруженного объекта. |
| toJSON() | Переопределяет метод JavaScript |
| track() | Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject). Если вы используете этот объект в вызовах |
| untrack() | Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить |
Сведения о свойстве
context
Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
context: RequestContext;Значение свойства
isAutoUpdated
Указывает, обновляется ли ссылка автоматически при открытии файла контейнера или при изменении исходного файла.
isAutoUpdated: boolean;Значение свойства
boolean
Комментарии
isLocked
Указывает, заблокирован ли Fieldобъект , InlineShapeили Shape , чтобы предотвратить автоматическое обновление.
isLocked: boolean;Значение свойства
boolean
Комментарии
isPictureSavedWithDocument
Указывает, сохраняется ли связанное изображение вместе с документом.
isPictureSavedWithDocument: boolean;Значение свойства
boolean
Комментарии
sourceFullName
Указывает путь и имя исходного файла для связанного объекта OLE, рисунка или поля.
sourceFullName: string;Значение свойства
string
Комментарии
sourceName
Возвращает имя исходного файла для связанного объекта OLE, рисунка или поля.
readonly sourceName: string;Значение свойства
string
Комментарии
sourcePath
Возвращает путь к исходному файлу для связанного объекта OLE, рисунка или поля.
readonly sourcePath: string;Значение свойства
string
Комментарии
type
Возвращает тип ссылки.
readonly type: Word.LinkType | "Ole" | "Picture" | "Text" | "Reference" | "Include" | "Import" | "Dde" | "DdeAuto" | "Chart";Значение свойства
Word.LinkType | "Ole" | "Picture" | "Text" | "Reference" | "Include" | "Import" | "Dde" | "DdeAuto" | "Chart"
Комментарии
Сведения о методе
breakLink()
Разрывает связь между исходным файлом и объектом OLE, рисунком или связанным полем.
breakLink(): void;Возвращаемое значение
void
Комментарии
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: Word.Interfaces.LinkFormatLoadOptions): Word.LinkFormat;Параметры
Предоставляет параметры свойств объекта для загрузки.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): Word.LinkFormat;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.
Возвращаемое значение
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Word.LinkFormat;Параметры
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.
Возвращаемое значение
set(properties, options)
Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.
set(properties: Interfaces.LinkFormatUpdateData, options?: OfficeExtension.UpdateOptions): void;Параметры
- properties
- Word.Interfaces.LinkFormatUpdateData
Объект JavaScript со свойствами, структурированными изоморфно по свойствам объекта, для которого вызывается метод .
- options
- OfficeExtension.UpdateOptions
Предоставляет возможность подавления ошибок, если объект свойств пытается задать какие-либо свойства, доступные только для чтения.
Возвращаемое значение
void
set(properties)
Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.
set(properties: Word.LinkFormat): void;Параметры
- properties
- Word.LinkFormat
Возвращаемое значение
void
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Word.LinkFormat объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Word.Interfaces.LinkFormatData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.
toJSON(): Word.Interfaces.LinkFormatData;Возвращаемое значение
track()
Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject). Если вы используете этот объект в вызовах .sync и вне последовательного выполнения пакета .run и получаете ошибку InvalidObjectPath при задании свойства или вызове метода для объекта, необходимо добавить объект в отслеживаемую коллекцию объектов при первом создании объекта. Если этот объект является частью коллекции, следует также отслеживать родительскую коллекцию.
track(): Word.LinkFormat;Возвращаемое значение
untrack()
Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить context.sync() до того, как выпуск памяти вступит в силу.
untrack(): Word.LinkFormat;