Продукты Р7
Корпоративный сервер 2024
Корпоративный сервер 2024
Сервер документов
Сервер документов
Редакторы документов
Редакторы документов
Корпоративный сервер 2019
Корпоративный сервер 2019
Графика
Графика
ВКС и мессенджер
ВКС и мессенджер
Мобильные редакторы
Мобильные редакторы
Почтовый сервер
Почтовый сервер
Органайзер
Органайзер
Сервер лицензирования
Сервер лицензирования
Файл-Экспресс
Файл-Экспресс
Аналитика
Аналитика
Дополнительно
Часто задаваемые вопросы
Разработчикам
Интеграции
Новые возможности

AddAddinField

Обновлено: 18.11.26

Описание. Вставляет поле надстройки в позицию курсора. Если в документе выделен текст, поле заменяет его.

Редакторы: документы.

Параметры

ПараметрТипОписание
dataобъектДанные поля: Value — служебная строка (обязательно), Content — видимый текст (необязательно)
  • Без Value поле не вставляется.
  • Без Content в поле вставляются четыре пробела.
  • FieldId передавать не нужно: редактор его игнорирует и назначает свой.

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

Метод ничего не возвращает: в функцию обратного вызова приходит undefined. Чтобы узнать FieldId нового поля, вызовите GetAllAddinFields.

Пример

Вставить поле с ценой товара и артикулом в служебной строке:

window.Asc.plugin.executeMethod("AddAddinField", [{
    Value: "price;sku=42",
    Content: "Цена: 100 руб."
}]);

Что такое поле надстройки

Поле надстройки — это поле документа типа ADDIN. В нем плагин хранит свои данные прямо в документе: пользователь видит только текст поля, а служебная строка скрыта в коде поля. Так, например, менеджеры библиографии хранят данные ссылок.

Все четыре метода работают с объектом поля из трех свойств:

СвойствоТипОписание
FieldIdстрокаИдентификатор поля в документе, например «1». Редактор назначает его сам и заново при каждом открытии файла
ValueстрокаДанные плагина, которые хранятся в коде поля. Пользователь их не видит
ContentстрокаТекст поля, который виден в документе

Поля с их Value и Content сохраняются в файле, а FieldId — нет: после повторного открытия у того же поля может быть другой FieldId. Поэтому не запоминайте FieldId между сеансами: записывайте свой идентификатор в Value, а актуальный FieldId берите из GetAllAddinFields перед каждым изменением.

Методы есть только в Документах. Изменения полей отменяются сочетанием Ctrl+Z за один шаг.

Была ли эта статья полезной?

Поделитесь пожалуйста своим мнением

      В статье есть ошибкиРекомендации не помоглиТекст трудно понятьСодержание статьи не соответствует заголовкуДругое