CheckboxField
Обзор
CheckboxField — это класс в Aspose.PDF FOSS для .NET. Наследует от: Field.
Этот класс предоставляет 33 метода для работы с объектами CheckboxField в программах .NET. Доступные методы включают: Accept, AddOption, ChangeAfterResize, CheckboxField, Clone, CopyTo, ExecuteFieldJavaScript, ExportToJson, ExportValueToJson, Field, Flatten, GetCheckedStateName и ещё 9 методов. Все публичные члены доступны в любом приложении .NET после установки пакета Aspose.PDF FOSS для .NET. Свойства: Action, Actions, ActiveState, Alignment, AllowedStates, AlternateName и ещё 78.
Свойства
| Имя: | Тип: | Доступ | Описание: |
|---|---|---|---|
Style | BoxStyle | Чтение/запись | Визуальный стиль отображаемого глифа флажка (/MK /CA): Cross рисует X, Check — галочку; остальные стили используют X. |
ExportValue | string | Чтение/запись | Экспортируемое значение, генерируемое в FDF/XFDF при отправке формы. |
ActiveState | string | Чтение/запись | Текущее выбранное состояние внешнего вида. |
AllowedStates | System.Collections.Generic.List<string> | Чтение | Все ключи состояния внешнего вида, объявленные под /AP/N. |
Value | string | Чтение/запись | Значение флажка (запись /V, тип name). |
OnValue | string | Чтение | Получает название состояния “On” для этого флажка (ключ состояния внешнего вида, который не является “Off”). |
IsChecked | bool | Чтение/запись | Получает или задает, отмечен ли. |
Checked | bool | Чтение/запись | Получает или задает значение Checked. |
Type | FieldType | Чтение | Тип поля. |
FullName | string? | Чтение | Полностью квалифицированное имя поля. |
TextHorizontalAlignment | Aspose.Pdf.HorizontalAlignment | Чтение/запись | Переопределение горизонтального выравнивания, специфичное для текста, применяемое к отображению виджета поля. |
PageIndex | int | Чтение | Индекс страницы, начиная с 1, которой принадлежит виджет этого поля. |
PartialName | string? | Чтение/запись | Частичное имя поля (/T). |
NormalAppearance | XForm? | Чтение | Обычное («Normal») отображение поля (запись /AP /N). |
Appearance | Aspose.Pdf.Annotations.AppearanceDictionary | Чтение | Потоки отображения виджета поля (запись /AP), индексированные по имени отображения. |
OnActivated | Annotations.PdfAction? | Чтение/запись | Действие, вызываемое при активации этого поля (запись /A). |
Count | int | Чтение | Количество элементов в массиве /Kids данного поля — либо дочерних полей (узлы иерархии), либо аннотаций-виджетов (терминальное поле с несколькими визуальными виджетами, например, сгруппированным флажком/радиокнопкой). |
Fields | Field[] | Чтение | Дочерние элементы типа Field этого поля в виде массива-снимка — удобный аксессор, отражающий Fields в форме. |
DefaultValue | string? | Чтение | Значение по умолчанию (/DV). |
AlternateName | string? | Чтение/запись | Альтернативное имя поля / подсказка (/TU entry). |
Flags | Aspose.Pdf.Annotations.AnnotationFlags | Чтение/запись | Флаги аннотации виджета (/F entry), например. |
TabOrder | int | Чтение/запись | Индекс порядка табуляции для этого поля. |
IsReadOnly | bool | Чтение | Указывает, является ли поле только для чтения. |
ReadOnly | bool | Чтение/запись | Указывает, является ли поле только для чтения (настраиваемый псевдоним для API parity). |
IsRequired | bool | Чтение | Указывает, является ли поле обязательным. |
Characteristics | Aspose.Pdf.Annotations.Characteristics | Чтение | Характеристики внешнего вида (цвета границы / фона, вращение виджета). |
DefaultAppearance | Aspose.Pdf.Annotations.DefaultAppearance | Чтение/запись | Внешний вид по умолчанию (шрифт, размер, цвет) поля — аналог на уровне поля для WidgetAnnotation. |
Rect | Rectangle? | Чтение/запись | Прямоугольник поля. |
Color | Color | Чтение/запись | Цвет поля (хранится в строке /DA default appearance в виде RGB). |
AnnotationIndex | int | Чтение/запись | Позиция вкладки виджета этого поля в массиве /Annots страницы, начиная с 1 — порядок элементов массива определяет порядок вкладок на странице. |
FitIntoRectangle | bool | Чтение/запись | Глобальный флаг: если true, значение поля автоматически изменяется по размеру, чтобы вписаться в прямоугольник виджета. |
IsGroup | bool | Чтение | Является ли это поле контейнером/группой дочерних полей. |
IsSharedField | bool | Чтение/запись | Является ли это поле частью группы общих полей. |
IsSynchronized | bool | Чтение | Является ли коллекция потокобезопасной. |
SyncRoot | object | Чтение | Корень синхронизации; возвращает этот экземпляр. |
MaxFontSize | double | Чтение/запись | Максимальный размер шрифта, используемый для автоматической подгонки внешнего вида поля. |
MinFontSize | double | Чтение/запись | Минимальный размер шрифта, используемый при автоподгонке внешнего вида поля. |
MappingName | string? | Чтение/запись | Имя сопоставления, используемое внешними скриптами для идентификации поля. |
AnnotationType | AnnotationType | Чтение | Всегда Widget. |
Border | Border? | Чтение/запись | Ширина, стиль и шаблон пунктиров границы определяются из словаря BS виджета (поля формы хранят свою границу там, а не в /Border). |
Actions | AnnotationActionCollection | Чтение | Слоты действий для дерева /AA виджета. |
Exportable | bool | Чтение/запись | Нужно ли экспортировать значение виджета при отправке формы. |
Highlighting | HighlightingMode | Чтение/запись | Режим визуального выделения, используемый, когда пользователь нажимает на виджет (/H entry). |
Parent | Forms.Field? | Чтение | Родительское поле, когда этот виджет является визуальным дочерним элементом поля AcroForm. |
Required | bool | Чтение/запись | Требуется ли заполнить виджет перед отправкой (/Ff bit 2). |
HighlightMode | string | Чтение | Режим выделения (/H entry). |
DefaultAppearanceString | string? | Чтение | Строка внешнего вида по умолчанию (/DA entry). |
FieldValue | string? | Чтение | Значение поля (/V entry). |
DefaultFieldValue | string? | Чтение | Значение поля по умолчанию (/DV entry). |
FieldType | string? | Чтение | Тип поля (/FT entry). |
InnerRect | Rectangle? | Чтение | Прямоугольник аннотации, смещённый записью /RD (различия прямоугольников) — область, фактически отрисованная внутри Rect. |
Width | double | Чтение/запись | Ширина прямоугольника аннотации. |
Height | double | Чтение/запись | Высота прямоугольника аннотации. |
Alignment | TextAlignment | Чтение/запись | Выравнивание текста (для free-text / widget аннотаций, содержащих форматированный текст). |
HorizontalAlignment | Aspose.Pdf.HorizontalAlignment | Чтение/запись | Горизонтальное выравнивание (доступно в дополнение к Alignment; оба параметра могут устанавливаться независимо). |
States | AppearanceDictionary | Чтение | Словарь состояний отображения (подсловарь per-state объекта AP/N, например. |
UpdateAppearanceOnConvert | bool | Чтение/запись | Нужно ли регенерировать поток отображения при сохранении аннотации в преобразованном документе. |
UseFontSubset | bool | Чтение/запись | Нужно ли выполнять субсетирование встроенного шрифта (если он присутствует). |
Contents | string? | Чтение/запись | Содержимое аннотации (текст). |
Opacity | double | Чтение/запись | Непрозрачность аннотации (0.0 = прозрачный, 1.0 = непрозрачный). |
InteriorColor | Color? | Чтение/запись | Внутренний цвет аннотации (/IC entry, для аннотаций круга/квадрата/линии). |
Title | string? | Чтение/запись | Заголовок аннотации (автор для разметочных аннотаций). |
Name | string? | Чтение/запись | Имя аннотации (уникальный идентификатор — запись /NM). |
Subject | string? | Чтение/запись | Тема аннотации (запись /Subj). |
ModifiedDate | string? | Чтение | Дата изменения. |
Modified | DateTime | Чтение/запись | Дата /M (modified) как типизированный DateTime. |
AnnotationFlags | AnnotationFlags | Чтение/запись | Типизированный алиас Flags, соответствующий публичному интерфейсу, который раскрывает AnnotationFlags как свойство. |
Action | PdfAction? | Чтение/запись | Действие, связанное с этой аннотацией (/A entry). |
Author | string? | Чтение | Автор аннотации (/T entry). |
AnnotationState | string? | Чтение | Состояние аннотации (/State entry), например. |
AnnotationStateModel | string? | Чтение | Модель состояния аннотации (/StateModel entry), например. |
ReplyType | string? | Чтение | Тип ответа (/RT entry), например. |
InReplyTo | Annotation? | Чтение/запись | Аннотация, на которую отвечает эта (запись /IRT). |
QuadPoints | Point[] | Чтение/запись | QuadPoints как массив значений Point. |
Page | Page? | Чтение | Страница, которой принадлежит эта аннотация, или null, если её нельзя определить (например. |
VerticalAlignment | VerticalAlignment | Чтение/запись | Вертикальное выравнивание применено к этому абзацу. |
Margin | MarginInfo | Чтение/запись | Информация о внешнем отступе применена к этому абзацу. |
IsFirstParagraphInColumn | bool | Чтение/запись | Заставить абзац начать новую колонку. |
IsKeptWithNext | bool | Чтение/запись | Оставьте этот абзац на той же странице, что и следующий. |
IsInNewPage | bool | Чтение/запись | Заставьте абзац начать с новой страницы. |
IsInLineParagraph | bool | Чтение/запись | Флаг встроенного абзаца (не начинается с новой строки). |
HyperlinkText | string? | Чтение/запись | Устаревшая строковая цель гиперссылки. |
Hyperlink | Hyperlink? | Чтение/запись | Типизированное оформление гиперссылки, применённое к абзацу. |
ZIndex | int | Чтение/запись | Индекс Z-order, используемый рендерером DOM. |
Методы
| Подпись | Описание: |
|---|---|
CheckboxField() | Создать по умолчанию несвязанное поле флажка. |
CheckboxField(doc: Document) | Создать чекбокс, привязанный к документу. |
CheckboxField(doc: Document, rect: Rectangle) | Создать чекбокс, привязанный к документу, с указанным прямоугольником виджета. |
CheckboxField(page: Page, rect: Rectangle) | Создайте checkbox на странице в указанном прямоугольнике. |
AddOption(optionName: string) | Добавьте optionName как новое выбираемое состояние для этого checkbox (используется для группированных checkbox, которые ведут себя как radio buttons). |
AddOption(optionName: string, rect: Rectangle) | Добавьте опцию с явно заданным прямоугольником виджета. |
AddOption(optionName: string, page: int, rect: Rectangle) | Добавьте опцию, указывающую номер заданной страницы и прямоугольник виджета. |
Clone() | Поверхностное клонирование поля. |
Field(doc: Document) | Создать поле, привязанное к документу. |
GetEnumerator() | Итерирует аннотации виджетов для дочерних элементов этого поля в массиве /Kids. |
CopyTo(array: Aspose.Pdf.Annotations.WidgetAnnotation[], index: int) | Копировать аннотации виджетов в массив, начиная с индекса. |
CopyTo(array: Field[], index: int) | Скопируйте дочерние элементы этого поля (в виде экземпляров Field) в массив, начиная с индекса. |
ExecuteFieldJavaScript(javaScriptAction: Aspose.Pdf.Annotations.JavascriptAction) | Выполните предоставленное действие JavaScript над этим полем. |
ExportToJson(stream: Stream) | Сериализуйте это поле в JSON (один объект FieldExportingData) через предоставленный поток. |
ExportToJson(fileName: string) | Сериализуйте это поле в файл JSON. |
ExportToJson(stream: Stream, options: ExportFieldsToJsonOptions?) | Сериализуйте это поле в JSON через предоставленный поток. |
ExportToJson(fileName: string, options: ExportFieldsToJsonOptions?) | Сериализуйте это поле в файл JSON. |
ExportValueToJson(outputJsonStream: Stream, indented: bool) | Запишите имя поля, флаги и значение в поток JSON. |
Flatten() | Сведите это поле к плоскому виду — превратите его значение в статический контент страницы. |
GetWidgetEnumerator() | Перечислитель типизирован WidgetAnnotation. |
ImportValueFromJson(inputJsonStream: Stream) | Прочитайте значение этого поля из потока JSON. |
ImportValueFromJson(inputJsonStream: Stream, fieldFullNameInJSON: string) | Прочитайте значение именованного поля из потока JSON — отдельный объект поля (возможно вложенный через ChildFields) или массив таких объектов — и примените значение записи, чей точечный путь соответствует fieldFullNameInJSON. |
Recalculate() | Пересчитайте значение поля с помощью его скрипта вычисления. |
SetPosition(point: Aspose.Pdf.Point) | Переместите первый прямоугольник виджета поля в указанную точку (верхний левый угол). |
WidgetAnnotation(doc: Document) | Программный конструктор — создает простую аннотацию-виджет, связанную с ридером документа. |
ExportToJson(stream: System.IO.Stream) | Сериализовать поле этого виджета как JSON в поток. |
ExportToJson(stream: System.IO.Stream, options: ExportFieldsToJsonOptions?) | Сериализовать поле этого виджета как один объект FieldExportingData JSON в поток. |
GetCheckedStateName() | Возвращает имя состояния внешнего вида, представляющего состояние «on» / «checked» этого виджета (обычно «Yes»), найденное в ключах словаря /AP/N (любое значение, отличное от «Off»). |
Accept(visitor: AnnotationSelector) | Вызывает Accept(visitor) у этого экземпляра CheckboxField. |
GetRectangle(considerRotation: bool) | Граничный прямоугольник скорректирован с учётом considerRotation. |
ChangeAfterResize(transform: Matrix) | Отрегулировать геометрию аннотации после того, как пользователь изменил размер страницы или хост-прямоугольника. |
UpdateAppearances() | Сгенерировать заново обычный поток отображения (/AP /N) из текущей геометрии и цветов аннотации. |
WriteXfdf(writer: System.Xml.XmlWriter) | Сериализуйте эту аннотацию как элемент XFDF в writer (PDF 32000 §12.7.8 / XFDF 3.0). |
