window.Asc.plugin.executeMethod\
(«InsertAndReplaceContentControls», [args], callback)
Описание
Определяет метод, позволяющий вставить элемент управления содержимым, содержащий данные. Данные задаются js-кодом для Document Builder или ссылкой на общий документ.
Использование
Этот метод следует использовать следующим образом:
window.Asc.plugin.executeMethod("InsertAndReplaceContentControls", [arrDocuments]);Параметры
| Параметр | Описание | Тип | Пример |
|---|---|---|---|
| arrDocuments | Массив свойств и содержимого элемента управления содержимым. Каждый объект из этого массива может иметь следующие значения: Props -свойства управления содержимым, Script — скрипт, который будет выполняться для генерации данных в элементе управления содержимым (можно заменить параметром Url), Url — ссылка на общий файл (может быть заменена параметром Script), | массив объектов |
Объект Props может иметь следующие значения:
Параметры
| Параметр | Описание | Тип | Пример |
|---|---|---|---|
| Id | Уникальный идентификатор элемента управления содержимым. Он может быть использован для поиска определенного элемента управления содержимым и ссылаться на него в коде. | целочисленный | 2 |
| Tag | Тег, назначенный элементу управления содержимым. Один и тот же тег может быть присвоен нескольким элементам управления содержимым, чтобы на них можно было ссылаться в коде. | строковый | «{tag}» |
| Lock | Значение, определяющее, можно ли удалять и/или редактировать элемент управления содержимым или нет. | целочисленный | 0 |
| InternalId | Уникальный внутренний идентификатор элемента управления содержимым. | строковый | «1_713» |
| Alias | Атрибут псевдонима. | строковый | «№1» |
| PlaceHolderText | Текст плейсхолдера элемента управления содержимым. | строковый | «placeholder text» |
| Appearance | Определяет, отображается ли элемент управления содержимым в виде ограничивающей рамки (1) или нет (2). | целочисленный | 1 |
| Color | Цвет текущего элемента управления содержимым в формате RGB:
| объект |
Параметр Lock может принимать следующие значения:
| Численное значение | Редактирование | Удалить |
|---|---|---|
| 0 | нет | да |
| 1 | нет | нет |
| 2 | да | нет |
| 3 | да | да |
Возвращает
Метод возвращает данные, которые содержит созданный элемент управления содержимым (в формате JSON):
[
{
"Tag": "Document",
"Id": 0,
"Lock": 0,
"InternalId": "1_713"
}
]Пример изменения существующего элемента управления содержимым:
var arrDocuments = [{
"Props": {
"InternalId": "2_803"
},
"Script": "var oParagraph = Api.CreateParagraph();oParagraph.AddText('New text');Api.GetDocument().InsertContent([oParagraph]);"
}]
window.Asc.plugin.executeMethod("InsertAndReplaceContentControls", [arrDocuments]);Пример добавления нового элемента управления содержимым:
var arrDocuments = [{
"Props": {
"Id": 100,
"Tag": "CC_Tag",
"Lock": 3
},
"Script": "var oParagraph = Api.CreateParagraph();oParagraph.AddText('Hello world!');Api.GetDocument().InsertContent([oParagraph]);"
}]
window.Asc.plugin.executeMethod("InsertAndReplaceContentControls", [arrDocuments]);
