Word.CoauthoringLock class

Пакет:

word

Представляет блокировку совместного редактирования в документе Word.

Extends

OfficeExtension.ClientObject

Комментарии

[ Набор API: WordApiDesktop 1.4 ]

Свойства

context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
owner	Возвращает владельца блокировки.
range	Range Возвращает объект , представляющий часть документа, которая содержится в объекте CoauthoringLock .
type	CoauthoringLockType Возвращает значение, представляющее тип блокировки.

Методы

load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
set(properties, options)	Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.
set(properties)	Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.
toJSON()	Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Word.CoauthoringLock объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Word.Interfaces.CoauthoringLockData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.
track()	Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject). Если вы используете этот объект в вызовах .sync и вне последовательного выполнения пакета .run и получаете ошибку InvalidObjectPath при задании свойства или вызове метода для объекта, необходимо добавить объект в отслеживаемую коллекцию объектов при первом создании объекта. Если этот объект является частью коллекции, следует также отслеживать родительскую коллекцию.
unlock()	Удаляет эту блокировку, даже если она принадлежит другому пользователю.
untrack()	Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить context.sync() до того, как выпуск памяти вступит в силу.

Сведения о свойстве

context

Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.

context: RequestContext;

Значение свойства

Word.RequestContext

owner

Возвращает владельца блокировки.

readonly owner: Word.Coauthor;

Значение свойства

Word.Coauthor

Комментарии

[ Набор API: WordApiDesktop 1.4 ]

range

Range Возвращает объект , представляющий часть документа, которая содержится в объекте CoauthoringLock .

readonly range: Word.Range;

Значение свойства

Word.Range

Комментарии

[ Набор API: WordApiDesktop 1.4 ]

type

CoauthoringLockType Возвращает значение, представляющее тип блокировки.

readonly type: Word.CoauthoringLockType | "None" | "Reservation" | "Ephemeral" | "Changed";

Значение свойства

Word.CoauthoringLockType | "None" | "Reservation" | "Ephemeral" | "Changed"

Комментарии

[ Набор API: WordApiDesktop 1.4 ]

Сведения о методе

load(options)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(options?: Word.Interfaces.CoauthoringLockLoadOptions): Word.CoauthoringLock;

Параметры

options

Word.Interfaces.CoauthoringLockLoadOptions

Предоставляет параметры свойств объекта для загрузки.

Возвращаемое значение

Word.CoauthoringLock

load(propertyNames)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNames?: string | string[]): Word.CoauthoringLock;

Параметры

propertyNames

string | string[]

Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.

Возвращаемое значение

Word.CoauthoringLock

load(propertyNamesAndPaths)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.CoauthoringLock;

Параметры

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.

Возвращаемое значение

Word.CoauthoringLock

set(properties, options)

Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.

set(properties: Interfaces.CoauthoringLockUpdateData, options?: OfficeExtension.UpdateOptions): void;

Параметры

properties

Word.Interfaces.CoauthoringLockUpdateData

Объект JavaScript со свойствами, структурированными изоморфно по свойствам объекта, для которого вызывается метод .

options

OfficeExtension.UpdateOptions

Предоставляет возможность подавления ошибок, если объект свойств пытается задать какие-либо свойства, доступные только для чтения.

Возвращаемое значение

void

set(properties)

Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.

set(properties: Word.CoauthoringLock): void;

Параметры

properties

Word.CoauthoringLock

Возвращаемое значение

void

toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Word.CoauthoringLock объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Word.Interfaces.CoauthoringLockData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

toJSON(): Word.Interfaces.CoauthoringLockData;

Возвращаемое значение

Word.Interfaces.CoauthoringLockData

track()

Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject). Если вы используете этот объект в вызовах .sync и вне последовательного выполнения пакета .run и получаете ошибку InvalidObjectPath при задании свойства или вызове метода для объекта, необходимо добавить объект в отслеживаемую коллекцию объектов при первом создании объекта. Если этот объект является частью коллекции, следует также отслеживать родительскую коллекцию.

track(): Word.CoauthoringLock;

Возвращаемое значение

Word.CoauthoringLock

unlock()

Удаляет эту блокировку, даже если она принадлежит другому пользователю.

unlock(): void;

Возвращаемое значение

void

Комментарии

[ Набор API: WordApiDesktop 1.4 ]

untrack()

Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить context.sync() до того, как выпуск памяти вступит в силу.

untrack(): Word.CoauthoringLock;

Возвращаемое значение

Word.CoauthoringLock