Word.Coauthoring class
Представляет Coauthoring объект . Это позволяет отслеживать обновления, изменения, конфликты и другие взаимодействия в документе, выполненные с помощью совместного редактирования.
- Extends
Комментарии
Свойства
| authors |
|
| can |
Возвращает значение, указывающее, может ли этот документ быть соавтором. |
| can |
Возвращает значение, указывающее, может ли документ быть автоматически объединен. |
| conflicts |
|
| context | Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office. |
| locks |
|
| me |
|
| pending |
Возвращает значение, указывающее, есть ли в документе ожидающие обновления, которые не были приняты. |
| updates |
|
Методы
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| toJSON() | Переопределяет метод JavaScript |
| track() | Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject). Если вы используете этот объект в вызовах |
| untrack() | Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить |
Сведения о свойстве
authors
CoauthorCollection Возвращает объект , представляющий всех соавторов, которые в настоящее время редактирует документ.
readonly authors: Word.CoauthorCollection;Значение свойства
Комментарии
canCoauthor
Возвращает значение, указывающее, может ли этот документ быть соавтором.
readonly canCoauthor: boolean;Значение свойства
boolean
Комментарии
canMerge
Возвращает значение, указывающее, может ли документ быть автоматически объединен.
readonly canMerge: boolean;Значение свойства
boolean
Комментарии
conflicts
ConflictCollection Возвращает объект , представляющий все конфликты в документе.
readonly conflicts: Word.ConflictCollection;Значение свойства
Комментарии
context
Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
context: RequestContext;Значение свойства
locks
CoauthoringLockCollection Возвращает объект , представляющий блокировки в документе.
readonly locks: Word.CoauthoringLockCollection;Значение свойства
Комментарии
me
Coauthor Возвращает объект , представляющий текущего пользователя.
readonly me: Word.Coauthor;Значение свойства
Комментарии
pendingUpdates
Возвращает значение, указывающее, есть ли в документе ожидающие обновления, которые не были приняты.
readonly pendingUpdates: boolean;Значение свойства
boolean
Комментарии
updates
CoauthoringUpdateCollection Возвращает объект , представляющий последние обновления, объединенные в документ.
readonly updates: Word.CoauthoringUpdateCollection;Значение свойства
Комментарии
Сведения о методе
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: Word.Interfaces.CoauthoringLoadOptions): Word.Coauthoring;Параметры
Предоставляет параметры свойств объекта для загрузки.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): Word.Coauthoring;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.
Возвращаемое значение
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Word.Coauthoring;Параметры
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.
Возвращаемое значение
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Word.Coauthoring объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Word.Interfaces.CoauthoringData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.
toJSON(): Word.Interfaces.CoauthoringData;Возвращаемое значение
track()
Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject). Если вы используете этот объект в вызовах .sync и вне последовательного выполнения пакета .run и получаете ошибку InvalidObjectPath при задании свойства или вызове метода для объекта, необходимо добавить объект в отслеживаемую коллекцию объектов при первом создании объекта. Если этот объект является частью коллекции, следует также отслеживать родительскую коллекцию.
track(): Word.Coauthoring;Возвращаемое значение
untrack()
Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить context.sync() до того, как выпуск памяти вступит в силу.
untrack(): Word.Coauthoring;