Word.Coauthor class

Пакет:

word

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

Extends

OfficeExtension.ClientObject

Комментарии

[ Набор API: WordApiDesktop 1.4 ]

Свойства

context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
emailAddress	Возвращает адрес электронной почты соавтора.
id	Возвращает уникальный идентификатор объекта Coauthor .
isMe	Возвращает значение, указывающее, представляет ли автор текущего пользователя.
locks	CoauthoringLockCollection Возвращает объект , представляющий блокировки в документе, связанные с этим соавтором.
name	Возвращает отображаемое имя соавтора.

Методы

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

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

context

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

context: RequestContext;

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

Word.RequestContext

emailAddress

Возвращает адрес электронной почты соавтора.

readonly emailAddress: string;

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

string

Комментарии

[ Набор API: WordApiDesktop 1.4 ]

id

Возвращает уникальный идентификатор объекта Coauthor .

readonly id: string;

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

string

Комментарии

[ Набор API: WordApiDesktop 1.4 ]

isMe

Возвращает значение, указывающее, представляет ли автор текущего пользователя.

readonly isMe: boolean;

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

boolean

Комментарии

[ Набор API: WordApiDesktop 1.4 ]

locks

CoauthoringLockCollection Возвращает объект , представляющий блокировки в документе, связанные с этим соавтором.

readonly locks: Word.CoauthoringLockCollection;

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

Word.CoauthoringLockCollection

Комментарии

[ Набор API: WordApiDesktop 1.4 ]

name

Возвращает отображаемое имя соавтора.

readonly name: string;

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

string

Комментарии

[ Набор API: WordApiDesktop 1.4 ]

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

load(options)

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

load(options?: Word.Interfaces.CoauthorLoadOptions): Word.Coauthor;

Параметры

options

Word.Interfaces.CoauthorLoadOptions

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

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

Word.Coauthor

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

Word.Coauthor

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths

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

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

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

Word.Coauthor

toJSON()

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

toJSON(): Word.Interfaces.CoauthorData;

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

Word.Interfaces.CoauthorData

track()

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

track(): Word.Coauthor;

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

Word.Coauthor

untrack()

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

untrack(): Word.Coauthor;

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

Word.Coauthor