Класс, представляющий форму кнопки типа 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();
