Class CheckboxField

Класс CheckboxField

Класс, представляющий поле флажка

public class CheckboxField : Field

Конструкторы

ИмяОписание
CheckboxField(Document)Конструктор для использования с Генератором.
CheckboxField(Document, Rectangle)Конструктор для класса CheckboxField.
CheckboxField(Page, Rectangle)Конструктор для класса CheckboxField.

Свойства

ИмяОписание
Actions { get; }Получает действия аннотации. (2 свойства)
override ActiveState { get; set; }Получает или устанавливает текущее состояние внешнего вида аннотации.
AllowedStates { get; }Возвращает список разрешенных состояний.
AlternateName { get; set; }Получает или устанавливает альтернативное имя поля (Альтернативное имя поля, которое будет использоваться вместо фактического имени поля, где бы поле ни идентифицировалось в пользовательском интерфейсе). Альтернативное имя используется в качестве подсказки для поля в Adobe Acrobat.
AnnotationIndex { get; set; }Получает или устанавливает индекс этой аннотации на странице.
override AnnotationType { get; }Получает тип аннотации.
Appearance { get; }Получает словарь внешнего вида аннотации.
Border { get; set; }Получает или устанавливает характеристики границы аннотации. Border
Characteristics { get; }Получает характеристики аннотации.
Checked { get; set; }Получает или устанавливает состояние флажка.
Color { get; set; }Получает или устанавливает цвет аннотации.
Contents { get; set; }Получает или устанавливает текст аннотации.
Count { get; }Получает количество подполей в этом поле. (Например, количество элементов в поле радиокнопки).
DefaultAppearance { get; set; }Получает или устанавливает внешний вид по умолчанию для поля.
Exportable { get; set; }Получает или устанавливает флаг экспортируемости поля.
ExportValue { get; set; }Получает или устанавливает экспортируемое значение поля CheckBox.
Flags { get; set; }Флаги аннотации.
FullName { get; }Получает полное квалифицированное имя аннотации.
virtual Height { get; set; }Получает или устанавливает высоту аннотации.
Highlighting { get; set; }Режим выделения аннотации.
virtual Hyperlink { get; set; }Получает или устанавливает гиперссылку фрагмента (для генератора pdf).
IsFirstParagraphInColumn { get; set; }Получает или устанавливает логическое значение, указывающее, будет ли этот абзац в следующем столбце. По умолчанию false. (для генерации pdf)
IsGroup { get; }Получает или устанавливает логическое значение, указывающее, является ли это поле нетерминальным полем, т.е. группой полей.
IsInLineParagraph { get; set; }Получает или устанавливает, является ли абзац встроенным. По умолчанию false. (для генерации pdf)
IsInNewPage { get; set; }Получает или устанавливает логическое значение, которое заставляет этот абзац генерироваться на новой странице. По умолчанию false. (для генерации pdf)
IsKeptWithNext { get; set; }Получает или устанавливает логическое значение, указывающее, остается ли текущий абзац на той же странице вместе с следующим абзацем. По умолчанию false. (для генерации pdf)
IsSharedField { get; set; }Свойство для поддержки Генератора. Используется, когда поле добавляется в заголовок или нижний колонтитул. Если true, это поле будет создано один раз, и его внешний вид будет виден на всех страницах документа. Если false, для каждой страницы документа будет создано отдельное поле.
IsSynchronized { get; }Возвращает true, если словарь синхронизирован.
Item { get; }Получает подполе, содержащееся в этом поле по имени подполя. (2 индексатора)
MappingName { get; set; }Получает или устанавливает имя сопоставления поля, которое будет использоваться при экспорте данных интерактивного поля формы из документа.
Margin { get; set; }Получает или устанавливает внешний отступ для абзаца (для генерации pdf)
Modified { get; set; }Получает или устанавливает дату и время, когда аннотация была недавно изменена.
Name { get; set; }Получает или устанавливает имя аннотации на странице.
OnActivated { get; set; }Действие, которое должно быть выполнено, когда аннотация активируется.
override PageIndex { get; }Получает индекс страницы, содержащей это поле.
Parent { get; }Получает родительскую аннотацию.
PartialName { get; set; }Получает или устанавливает частичное имя поля.
ReadOnly { get; set; }Получает или устанавливает статус только для чтения поля.
override Rect { get; set; }Получает или устанавливает прямоугольник поля.
Required { get; set; }Получает или устанавливает статус обязательности поля.
States { get; }Получает словарь внешнего вида аннотации.
Style { get; set; }Получает или устанавливает стиль флажка.
SyncRoot { get; }Объект синхронизации.
TabOrder { get; set; }Получает или устанавливает порядок табуляции поля.
TextHorizontalAlignment { get; set; }Получает или устанавливает выравнивание текста для аннотации.
override Value { get; set; }Получает или устанавливает значение поля флажка.
virtual VerticalAlignment { get; set; }Получает или устанавливает вертикальное выравнивание абзаца
virtual Width { get; set; }Получает или устанавливает ширину аннотации.
ZIndex { get; set; }Получает или устанавливает целочисленное значение, указывающее Z-упорядочение графика. График с большим ZIndex будет размещен над графиком с меньшим ZIndex. ZIndex может быть отрицательным. График с отрицательным ZIndex будет размещен за текстом на странице.

Методы

ИмяОписание
override Accept(AnnotationSelector)Принимает посетителя.
AddOption(string)Добавляет новый флажок в группу флажков, в которой в любой момент может быть отмечен не более одного флажка. Новый флажок добавляется в конец группы.
AddOption(string, Rectangle)Добавляет новый флажок в группу флажков, в которой в любой момент может быть отмечен не более одного флажка.
AddOption(string, int, Rectangle)Добавляет новый флажок в группу флажков, в которой в любой момент может быть отмечен не более одного флажка.
virtual ChangeAfterResize(Matrix)Обновляет параметры и внешний вид в соответствии с матричным преобразованием.
override Clone()Клонирует флажок.
CopyTo(WidgetAnnotation[], int)Копирует подполе этого поля в массив, начиная с указанного индекса.
ExecuteFieldJavaScript(JavascriptAction)Выполняет указанное действие JavaScript для поля.
ExportToJson(Stream, ExportFieldsToJsonOptions)Экспортирует указанное поле формы PDF в формат JSON и записывает результат в предоставленный поток.
ExportToJson(string, ExportFieldsToJsonOptions)Экспортирует указанное поле формы PDF в формат JSON и записывает результат в указанный файл.
ExportValueToJson(Stream, bool)Экспортирует содержимое указанного поля в поток JSON. Значения кнопок не экспортируются.
override Flatten()Удаляет это поле и помещает его значение непосредственно на страницу.
GetCheckedStateName()Возвращает имя состояния “отмечено” в соответствии с существующими именами состояний.
GetEnumerator()Возвращает перечислитель содержащихся полей.
GetRectangle(bool)Возвращает прямоугольник аннотации с учетом поворота страницы.
ImportValueFromJson(Stream)Импортирует данные в указанные поля из потока JSON на основе точного совпадения полных имен полей.
ImportValueFromJson(Stream, string)Импортирует данные в указанное поле из потока JSON, используя полное имя, указанное в переменной ‘fieldFullNameInJSON’ для сопоставления.
Recalculate()Пересчитывает все вычисляемые поля на форме.
virtual SetPosition(Point)Устанавливает позицию поля.

Примеры

Пример демонстрирует, как создать поле флажка с несколькими значениями.

using (var document = new Document())
{
var page = document.Pages.Add();

var checkbox = new CheckboxField(page, new Rectangle(50, 50, 70, 70));

// Set the first checkbox group option value
checkbox.ExportValue = "option 1";

// Add new option right under existing ones
checkbox.AddOption("option 2");

// Add new option at the given rectangle
checkbox.AddOption("option 3", new Rectangle(100, 100, 120, 120));

document.Form.Add(checkbox);

// Select the added checkbox
checkbox.Value = "option 2";
document.Save("checkbox_group.pdf");
}

См. также

Class ButtonField Class ChoiceField