ApiCheckBoxForm

new ApiCheckBoxForm()

Класс, представляющий форму кнопки типа checkbox / radio.

Свойства

НазваниеТипОписание
radioлогическийУказывает, является ли текущий переключатель типом radio button. В этом случае ключевой параметр рассматривается как идентификатор для группы переключателей.

Методы

НазваниеОписание
ClearОчищает текущую форму.
CopyКопирует текущую форму (копирует вместе с формой, если она существует).
GetClassTypeВозвращает тип класса ApiFormBase.
GetFormKeyВозвращает текущий ключ формы.
GetFormTypeВозвращает тип текущей формы.
GetRadioGroupВозвращает ключ группы переключателей, если текущий флажок является переключателем.
GetTextВозвращает текст из текущей формы. Этот метод используется только для текстовых форм и полей со списком.
GetTextPrВозвращает свойства текста из текущей формы. Этот метод используется только для текстовых форм и полей со списком.
GetTipTextВозвращает текст подсказки текущей формы.
GetWrapperShapeВозвращает фигуру, в которую помещена форма для управления положением и размером рамки формы фиксированного размера. Для встроенных форм будет возвращено нулевое значение.
IsCheckedВозвращает состояние текущего флажка (установлен или нет).
IsFixedПроверяет, имеет ли текущая форма фиксированный размер.
IsRadioButtonПроверяет, является ли текущий флажок переключателем.
IsRequiredПроверяет, нужна ли текущая форма.
SetBackgroundColorУстанавливает цвет фона для текущей формы.
SetBorderColorУстанавливает цвет границы для текущей формы.
SetCheckedПроверяет текущий флажок.
SetFormKeyЗадает ключ для текущей формы.
SetPlaceholderTextУстанавливает плейсхолдер в текущую форму. Не может быть установлен флажок или переключатель.
SetRadioGroupУстанавливает ключ группы переключателя на текущий флажок.
SetRequiredУказывает, должна ли текущая форма быть обязательной.
SetTextPrЗадает свойства текста для текущей формы. Этот метод используется только для текстовых форм и полей со списком.
SetTipTextУстанавливает текст подсказки в текущую форму.
ToFixedКонвертирует текущую форму в форму фиксированного размера.
ToInlineПреобразует текущую форму во встроенную форму. Форма изображения не может быть преобразована во встроенную форму, это всегда объект фиксированного размера.

Пример

builder.CreateFile("docx");
var oDocument = Api.GetDocument();
var oCheckBoxForm = Api.CreateCheckBoxForm({"tip": "Specify your marital status", "required": true, "placeholder": "Marital status", "radio": true});
oCheckBoxForm.SetRadioGroup("Marital status");
var oParagraph = oDocument.GetElement(0);
oParagraph.AddElement(oCheckBoxForm);
oParagraph.AddText(" Married");
oParagraph.AddLineBreak();
oCheckBoxForm = Api.CreateCheckBoxForm({"tip": "Specify your marital status", "required": true, "placeholder": "Marital status", "radio": true});
oCheckBoxForm.SetRadioGroup("Marital status");
oParagraph.AddElement(oCheckBoxForm);
oParagraph.AddText(" Single");
var sRadioGroup = oCheckBoxForm.GetRadioGroup();
var bRadioButton = oCheckBoxForm.IsRadioButton();
oCheckBoxForm.SetChecked(true);
var bChecked = oCheckBoxForm.IsChecked();
oParagraph = Api.CreateParagraph();
oParagraph.AddText("The second checkbox from this document is a radio button: " + bRadioButton);
oParagraph.AddLineBreak();
oParagraph.AddText("The second checkbox from this document is checked: " + bChecked);
oParagraph.AddLineBreak();
oParagraph.AddText("Radio group name of the radio buttons in this document: " + sRadioGroup);
oDocument.Push(oParagraph);
builder.SaveFile("docx", "ApiCheckBoxForm.docx");
builder.CloseFile();