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

SetProperties

Обновлено: 04.08.26

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

Описание

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

Использование

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

window.Asc.plugin.executeMethod ("SetProperties", [obj]);

Параметры

ПараметрОписаниеТипПример
objСвойства документа. Этот объект может иметь следующие значения:

  • copyoutenabled отключает копирование из редактора, если установлено значение false,
    тип: логический,
    пример: false;
  • hideContentControlTrack отключает отслеживание элемента управления содержимым, если установлено значение true,
    type: логический,
    example: true;
  • watermark_on_draw — строковое значение для свойств водяного знака в формате JSON,
    тип: строковый,
    пример: «{watermark}».
  • disableAutostartMacros устанавливает флаг, указывающий, что макросы запускаются автоматически при открытии редактора,
    тип: логический,
    пример: true;
  • fillForms устанавливает правила в формате JSON для заполнения форм документов по тегам,
    тип: строковый,
    пример: «{forms}».
объект

Свойства водного знака

ПараметрыОписаниеТипПример
transparentСтепень прозрачности водяного знака.плавающий0.3
typeТип формы, который задает заданную геометрию формы для текущего водяного знака.строковый«rect»
widthШирина водяного знака, измеряемая в миллиметрах.целочисленное100
heightВысота водяного знака, измеряемая в миллиметрах.целочисленное100
rotateУгол поворота водяного знака, измеряемый в градусах.целочисленное-45
marginsМассив с пробегами из текущего абзаца с их свойствами:массив целых чисел[10, 10, 10, 10]
fillЦвет заливки водяного знака в формате RGB. Пустой массив [] означает, что водяной знак не имеет заливки.массив целых чисел[255, 0, 0]
stroke-widthШирина штриха водяного знака, измеряемая в миллиметрах.целочисленное1
strokeЦвет обводки водяного знака в формате RGB. Пустой массив [] означает, что обводка водяного знака не имеет заливки.массив целых чисел[0, 0, 255]
alignВыравнивание текста по вертикали в форме водяного знака: 0 — внизу, 1 — по центру, 4 — вверху.целочисленное1
paragraphsМассив абзацев из текущего водяного знака с их свойствами.массив целых чисел
paragraphs.alignГоризонтальное выравнивание текста в текущем абзаце: 0 — справа, 1 — слева, 2 — по центру, 3 — выравнивание.целочисленное2
paragraphs.fillПодсветка абзаца в формате RGB. Пустой массив [] означает, что абзац не выделен.массив целых чисел[255, 0, 0]
paragraphs.linespacingТекстовая разметка в текущем абзаце.целочисленное1
paragraphs.runsМассив с прогонами из текущего абзаца с их свойствами:

  • text — текст прогона,
    тип: строковый,
    пример: «Do not steal, %user_name%!»;
  • fill -выделение текста в формате RGB. Пустой массив [] означает, что текст не выделен,
    тип:массив целых чисел,
    пример: [0, 0, 0];
  • font-family -семейство шрифтов текста,
    тип: строковый,
    пример: «Arial»;
  • font-size — размер шрифта текста, измеряемый в пунктах (pt),
    тип: строковый,
    пример: 40;
  • bold — определяет, будет ли текущий текст отображаться полужирным шрифтом или нет,
    тип: логический,
    пример: true;
  • italic — определяет, будет ли текущий текст отображаться курсивом или нет,
    тип: логический,
    пример: false;
  • strikeout — определяет, будет ли текущий текст отображаться перечеркнутым или нет,
    тип: логический,
    пример: false;
  • underline — определяет, будет ли текущий текст отображаться подчеркнутым или нет,
    тип: логический,
    пример: false.
массив объектов

Свойства формы

ПараметрыОписаниеТипПример
tagsТеги формы, которые определяют содержимое для каждого типа формы с таким тегом:

  • text — значение текстового поля (некий текст),
  • тип: строковый,
    пример: «Р7»;
  • checkBox — значение формы флажка («true» — отмечено, «false» — не отмечено),
    тип: строковый,
    пример: «true»;
  • picture -значение формы изображения (ссылка на изображение),
    тип: строковый,
    пример: «https://upload.wikimedia.org/wikipedia/commons/9/91/Р7_logo.png»;
  • comboBox — значение формы комбинированного списка (один из элементов из списка значений комбинированного списка),
    тип: строковый,
    пример: «item1».
объект

Возвращает

Метод возвращает неопределенное значение.

Пример

initSettings = {
    "copyoutenabled" : false,
    "hideContentControlTrack" : false,
    "watermark_on_draw" : JSON.stringify({
        "transparent" : 0.3,
        "type" : "rect",
        "width" : 100,
        "height" : 100,
        "rotate" : -45,
        "margins" : [ 10, 10, 10, 10 ],
        "fill" : [255, 0, 0],
        "stroke-width" : 1,
        "stroke" : [0, 0, 255],
        "align" : 1,
                        
        "paragraphs" : [ {
            "align" : 2,
            "fill" : [255, 0, 0],
            "linespacing" : 1,
                        
            "runs" : [
                        {
                            "text" : "Do not steal, %user_name%!",
                            "fill" : [0, 0, 0],
                            "font-family" : "Arial",
                            "font-size" : 40,
                            "bold" : true,
                            "italic" : false,
                            "strikeout" : false,
                            "underline" : false
                        },
                        {
                            "text" : "<%br%>"
                        }
                    ]
            }
        ]
    }),
    "disableAutostartMacros" : true,
    "fillForms" : JSON.stringify({
        "tags" : {
            "111" : {
                "text" : "Text in form with tag 111",
                "checkBox" : "true",
                "picture" : "https://upload.wikimedia.org/wikipedia/commons/9/91/Р7_logo.png",
                "comboBox" : "item1"
            },
            "222" : {
                "text" : "Text in form with tag 222",
                "checkBox" : "false",
                "comboBox" : "item2"
            },
            "333" : {
                "text" : "Р7"
            }
        }
    })
};
window.Asc.plugin.executeMethod("SetProperties", [initSettings]);

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

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

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