Word.Editor class

Представляет пользователя с разрешениями на редактирование авторизованных частей защищенного (только для чтения) документа Word. Дополнительные сведения см. в разделе Разрешить изменения частей защищенного Word документа.

Свойства

context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
id	Возвращает идентификатор объекта при `Editor` сохранении родительского документа в качестве веб-страницы.
name	Возвращает имя редактора.
nextRange	`Range` Возвращает объект , представляющий следующий диапазон, который редактор имеет разрешения на изменение.
range	`Range` Возвращает объект , представляющий часть документа, которая содержится в объекте `Editor` .

Методы

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

context

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

context: RequestContext;

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

Word.RequestContext

id

Возвращает идентификатор объекта при Editor сохранении родительского документа в качестве веб-страницы.

readonly id: string;

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

string

name

Возвращает имя редактора.

readonly name: string;

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

string

nextRange

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

readonly nextRange: Word.Range;

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

Word.Range

range

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

readonly range: Word.Range;

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

Word.Range

delete()

Удаляет Editor объект .

delete(): void;

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

void

load(options)

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

load(options?: Word.Interfaces.EditorLoadOptions): Word.Editor;

Параметры

options: Word.Interfaces.EditorLoadOptions

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

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

Word.Editor

load(propertyNames)

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

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

Параметры

propertyNames: string | string[]

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

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

Word.Editor

load(propertyNamesAndPaths)

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

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

Параметры

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

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

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

Word.Editor

removeAllPermissions()

Удаляет все разрешения на редактирование в документе для редактора. Редактор будет удален при следующем открытии документа.

removeAllPermissions(): void;

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

void

selectAllShapes()

Выбирает все фигуры в документе, которые были вставлены или изменены редактором.

selectAllShapes(): void;

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

void

set(properties, options)

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

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

Параметры

properties: Word.Interfaces.EditorUpdateData

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

options: OfficeExtension.UpdateOptions

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

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

void

set(properties)

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

set(properties: Word.Editor): void;

Параметры

properties: Word.Editor

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

void

toJSON()

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

toJSON(): Word.Interfaces.EditorData;

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

Word.Interfaces.EditorData

track()

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

track(): Word.Editor;

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

Word.Editor

untrack()

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

untrack(): Word.Editor;

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

Word.Editor

Комментарии

Используется

Свойства

Методы

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

context

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

id

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

Комментарии

name

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

Комментарии

nextRange

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

Комментарии

range

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

Комментарии

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

delete()

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

Комментарии

load(options)

Параметры

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

load(propertyNames)

Параметры

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

load(propertyNamesAndPaths)

Параметры

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

removeAllPermissions()

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

Комментарии

selectAllShapes()

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

Комментарии

set(properties, options)

Параметры

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

set(properties)

Параметры

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

toJSON()

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

track()

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

untrack()

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

Обратная связь