Word.EditorCollection class
Представляет редакторов в защищенном документе Word (только для чтения).
- Extends
Свойства
| context | Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office. |
Методы
| add |
Возвращает |
| add |
Возвращает объект, |
| add |
Возвращает объект, |
| get |
Возвращает число элементов в коллекции. |
| get |
Получает |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| toJSON() | Переопределяет метод JavaScript |
| track() | Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением от context.trackedObjects.add(thisObject). Если вы используете этот объект во всех |
| untrack() | Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращением от context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вам нужно позвонить |
Сведения о свойстве
context
Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
context: RequestContext;Значение свойства
Сведения о методе
addById(editorId)
Возвращает Editor объект, представляющий новое разрешение для указанного пользователя на изменение диапазона в документе.
addById(editorId: string): Word.Editor;Параметры
- editorId
-
string
Псевдоним электронной почты пользователя (если в том же домене) или адрес электронной почты.
Возвращаемое значение
Комментарии
addByType(editorType)
Возвращает объект, Editor представляющий новое разрешение указанной группе пользователей на изменение диапазона в документе.
addByType(editorType: Word.EditorType): Word.Editor;Параметры
- editorType
- Word.EditorType
An EditorType представляет группу пользователей.
Возвращаемое значение
Комментарии
addByType(editorType)
Возвращает объект, Editor представляющий новое разрешение указанной группе пользователей на изменение диапазона в документе.
addByType(editorType: "Current" | "Editors" | "Everyone" | "Owners"): Word.Editor;Параметры
- editorType
-
"Current" | "Editors" | "Everyone" | "Owners"
An EditorType представляет группу пользователей.
Возвращаемое значение
Комментарии
getCount()
Возвращает число элементов в коллекции.
getCount(): OfficeExtension.ClientResult<number>;Возвращаемое значение
OfficeExtension.ClientResult<number>
Комментарии
getItemAt(index)
Получает Editor объект по его индексу в коллекции.
getItemAt(index: number): Word.Editor;Параметры
- index
-
number
Индекс извлекаемого элемента.
Возвращаемое значение
Комментарии
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): Word.EditorCollection;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, которые определяют свойства для загрузки.
Возвращаемое значение
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Word.EditorCollection;Параметры
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и строка propertyNamesAndPaths.expand через запятую, указывающая свойства навигации для загрузки.
Возвращаемое значение
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод переданного ему объекта.) В то время как исходный Word.EditorCollection объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как Word.Interfaces.EditorCollectionData), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.
toJSON(): {
[key: string]: string;
};Возвращаемое значение
{ [key: string]: string; }
track()
Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением от context.trackedObjects.add(thisObject). Если вы используете этот объект во всех .sync вызовах и вне последовательного выполнения пакета ".run" и получаете сообщение об ошибке "InvalidObjectPath" при установке свойства или вызове метода объекта, необходимо добавить объект в коллекцию отслеживаемых объектов при его первом создании. Если этот объект является частью семейства, следует также отслеживать родительскую коллекцию.
track(): Word.EditorCollection;Возвращаемое значение
untrack()
Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращением от context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вам нужно позвонить context.sync() , прежде чем освобождение памяти вступит в силу.
untrack(): Word.EditorCollection;