Перейти к основному содержимому
Версия: Next

Interface: HostEditorApi

API взаимодействия хост-приложения с редактором.

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

Remarks

Обычно возвращается как результат вызова DocumentOpenApi.openDocument.

Example

Получение и использование HostEditorApi

const openApi = await new EditorBuilder().withAutonomousMode().withLicenseToken('xxx.xxx.xxx').mount(container, url);

const hostApi = await openApi.openDocument({ filename: 'my-file.docx', content });

// Работа с документом
hostApi.editorApi.insertText('Привет!');

// Файловые операции
await hostApi.saveDocument('docx');

// Надстройки
await hostApi.pluginsApi.startPlugin(myPluginId, pluginCode);

Methods

saveDocument()

saveDocument(format): Promise<SaveDocumentResult>

Сохраняет текущий открытый документ в заданном формате.

Parameters

format

SaveFormat

Формат сохранения, поддерживается 'docx', 'xlsx', 'pdf', 'pptx'

Returns

Promise<SaveDocumentResult>

Promise с объектом:

  • arrayBuffer: ArrayBuffer — содержимое документа
  • extension: string | null — расширение результата ('docx', 'pdf', ...)

Example

const result = await hostApi.saveDocument(SaveFormat.OXML);

Properties

editorApi

editorApi: EditorApi

Подмодуль управления содержимым документа, UI и событиями.

See

EditorApi Описание всех методов работы с документом, UI и событиями

Inherited from

BaseHostEditorApi.editorApi


plugins

plugins: PluginsApi

Подмодуль для управления и расширения функционала редактора через надстройки.

See

PluginsApi Методы создания, регистрации и удаления надстроек

Inherited from

BaseHostEditorApi.plugins