• Post category:executeMethod
  • Запись изменена:07.11.2022

window.Asc.plugin.executeMethod («AddContentControl», [args], callback)

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

Применение
Этот метод следует использовать следующим образом:

window.Asc.plugin.executeMethod ("AddContentControl", [type, commonPr]);
Параметры
Параметр Описание Тип Пример
type Числовое значение, указывающее тип элемента управления содержимым. Он может иметь одно из следующих значений: 1 (блок), 2 (встроенный), 3 (строка) или 4 (ячейка). целое число 2
commonPr Определяет общие свойства элемента управления содержимым:

  • Id — уникальный идентификатор элемента управления содержимым. Его можно использовать для поиска определенного элемента управления содержимым и ссылки на него в коде.
    тип: целое число,
    пример: 2;
  • Tag —  тег, назначенный элементу управления содержимым. Один и тот же тег можно назначить нескольким элементам управления содержимым, чтобы можно было ссылаться на них в коде.
    тип: строковый,
    пример: «{tag}»;
  • Lock — значение, которое определяет, возможно ли удалить и/или изменить элемент управления содержимым или нет,
    тип: целое число,
    пример: 0;
  • InternalId — уникальный внутренний идентификатор элемента управления контентом,
    type: строковый,
    пример: «1_713»;
  • Alias -атрибут псевдонима,
    тип: строковый,
    пример: «№1»;
  • PlaceHolderText — текст-заполнитель элемента управления содержимым,
    тип: строковый,
    пример: «placeholder text»;
  • Appearance — определяет, отображается ли элемент управления содержимым в виде ограничивающей рамки (1) или нет (2),
    тип: целое число,
    пример: 1;
  • Color -цвет для текущего элемента управления содержимым в формате RGB (R — значение составляющей красного цвета, G — значение составляющей зеленого цвета, B — значение составляющей синего цвета). Например: {«R»: 0, «G»: 0, «B»: 255},
    тип: объект.
объект

Параметр Lock может принимать следующие значения:

Числовое значение Редактировать Удалить
0 Нет Да
1 Нет Нет
2 Да Нет
3 Да Да

Возвращает
Метод возвращает JSON — объект, содержащий данные о созданном элементе управления содержимым, в следующем виде:

{
    "Tag": "{tag}",
    "Id": 0,
    "Lock": 0,
    "InternalId": "1_713"
}
Параметры
Параметр Описание Тип Пример
Tag Тег, назначенный элементу управления содержимым. Один и тот же тег можно назначить нескольким элементам управления содержимым, чтобы можно было ссылаться на них в коде. строковый «{tag}»
Id Уникальный идентификатор элемента управления содержимым. Его можно использовать для поиска определенного элемента управления содержимым и ссылки на него в коде. целое число 2
Lock Значение, которое определяет, возможно ли удалить и/или изменить элемент управления содержимым или нет. целое число 0
InternalId Уникальный внутренний идентификатор элемента управления содержимым. строковый «1_713»
Пример
window.Asc.plugin.executeMethod ("AddContentControl", [1, {"Id" : 7, "Tag" : "{tag}", "Lock" : 0}]);