ComboBoxField
Обзор
ComboBoxField — это класс в Aspose.PDF FOSS для .NET. Наследуется от: ChoiceField.
Combo box (drop-down) поле формы — ChoiceField с установленным флагом Combo.
Этот класс предоставляет 36 методов для работы с объектами ComboBoxField в программах .NET. Доступные методы включают: Accept, AddOption, ChangeAfterResize, ChoiceField, Clone, ComboBoxField, CopyTo, DeleteOption, ExecuteFieldJavaScript, ExportToJson, ExportValueToJson, Field и ещё 11 методов. Все публичные члены доступны любому приложению .NET после установки пакета Aspose.PDF FOSS для .NET. Свойства: Action, Actions, ActiveState, Alignment, AlternateName, AnnotationFlags и ещё 85.
Свойства
| Имя: | Тип: | Доступ | Описание: |
|---|---|---|---|
Editable | bool | Чтение/запись | Разрешено ли пользователю вводить произвольное значение (/Ff bit 19, Edit). |
SpellCheck | bool | Чтение/запись | Включена ли проверка орфографии (/Ff bit 23, DoNotSpellCheck inverted). |
IsCombo | bool | Чтение | Получает значение is combo. |
IsEditable | bool | Чтение | Получает значение свойства isEditable. |
IsMultiSelect | bool | Чтение | Получает значение IsMultiSelect. |
IsSorted | bool | Чтение | Получает признак сортировки. |
MultiSelect | bool | Чтение/запись | Получить/установить MultiSelect (/Ff бит 22 — 0-based 21). |
CommitImmediately | bool | Чтение/запись | Получить/установить CommitOnSelChange (/Ff бит 27 — 0-based 26). |
SelectedItems | int[] | Чтение/запись | Индексы выбранных опций, нумерация с нуля (public-API shape int[] sibling of SelectedIndices; setter переписывает /V из совпадающих вариантов). |
SelectedValues | IReadOnlyList<string> | Чтение/запись | Текущие выбранные значения. |
SelectedIndices | IReadOnlyList<int> | Чтение | Индексы выбранных значений, начинающиеся с нуля, в списке Options. |
Options | OptionCollection | Чтение | Коллекция вариантов выбора. |
Selected | int | Чтение/запись | Индекс текущего выбранного варианта, начиная с 1, или -1, когда вариант не выбран или выбор нельзя сопоставить со списком вариантов. |
Value | string? | Чтение/запись | Значение поля (/V). |
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), например. |
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 | Чтение/запись | Определяет, принадлежит ли это поле группе shared-fields. |
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). |
FieldType | string? | Чтение | Тип поля (запись /FT). |
InnerRect | Rectangle? | Чтение | Прямоугольник аннотации, уменьшенный на запись /RD (различия прямоугольников) — область, фактически нарисованная внутри Rect. |
Width | double | Чтение/запись | Ширина прямоугольника аннотации. |
Height | double | Чтение/запись | Высота прямоугольника аннотации. |
ActiveState | string? | Чтение/запись | Текущее активное состояние внешнего вида (/AS entry). |
Alignment | TextAlignment | Чтение/запись | Выравнивание текста (для свободного текста / виджет-аннотаций, содержащих форматированный текст). |
HorizontalAlignment | Aspose.Pdf.HorizontalAlignment | Чтение/запись | Горизонтальное выравнивание (отображается в дополнение к Alignment; оба могут устанавливаться независимо). |
States | AppearanceDictionary | Чтение | Словарь состояний отображения (подсловарь для каждого состояния AP/N, например, |
UpdateAppearanceOnConvert | bool | Чтение/запись | Нужно ли регенерировать поток отображения при сохранении аннотации в преобразованном документе. |
UseFontSubset | bool | Чтение/запись | Нужно ли субсетировать встроенный шрифт (если он есть). |
Contents | string? | Чтение/запись | Содержимое аннотации (текст). |
Opacity | double | Чтение/запись | Непрозрачность аннотации (0.0 = прозрачная, 1.0 = непрозрачная). |
InteriorColor | Color? | Чтение/запись | Внутренний цвет аннотации (запись /IC, для аннотаций круг/квадрат/линия). |
Title | string? | Чтение/запись | Заголовок аннотации (автор для разметочных аннотаций). |
Name | string? | Чтение/запись | Имя аннотации (уникальный идентификатор — запись /NM). |
Subject | string? | Чтение/запись | Тема аннотации (/Subj entry). |
ModifiedDate | string? | Чтение | Дата модификации. |
Modified | DateTime | Чтение/запись | Дата /M (modified) в виде типизированного DateTime. |
AnnotationFlags | AnnotationFlags | Чтение/запись | Типизированный псевдоним Flags, соответствующий публичному интерфейсу, который предоставляет AnnotationFlags в виде свойства. |
Action | PdfAction? | Чтение/запись | Действие, связанное с этой аннотацией (запись /A). |
Author | string? | Чтение | Автор аннотации (запись /T). |
AnnotationState | string? | Чтение | Состояние аннотации (/State entry), например, |
AnnotationStateModel | string? | Чтение | Модель состояния аннотации (/StateModel entry), например, |
ReplyType | string? | Чтение | Тип ответа (/RT entry), например, |
InReplyTo | Annotation? | Чтение/запись | Аннотация, на которую отвечает эта запись (/IRT entry). |
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. |
Методы
| Подпись | Описание: |
|---|---|
ComboBoxField() | Конструктор без параметров (вызывающий привязывает его к странице позже). |
ComboBoxField(doc: Document) | Конструктор, привязанный к документу; rectangle по умолчанию пустой. |
ComboBoxField(doc: Document, rect: Rectangle) | Конструктор, привязанный к документу, с явно заданным прямоугольником. |
ComboBoxField(page: Page, rect: Rectangle) | Создаёт новое поле комбобокса на указанной странице с заданным прямоугольником. |
ChoiceField(doc: Document) | Вызывает ChoiceField(doc) у этого экземпляра ComboBoxField. |
ChoiceField(doc: Document, rect: Rectangle) | Вызывает ChoiceField(doc, rect) у этого экземпляра ComboBoxField. |
ChoiceField(page: Page, rect: Rectangle) | Выполняет вызов ChoiceField(page, rect) у этого экземпляра ComboBoxField. |
AddOption(optionName: string) | Добавьте опцию в поле выбора. |
AddOption(export: string, name: string) | Добавьте опцию с отдельными значениями экспорта и отображения. |
DeleteOption(optionName: string) | Удалите первую опцию, совпадающую с optionName (либо как простой PdfString, либо как отображаемую часть пары [export, name]). |
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) | Программный ctor — создаёт пустую аннотацию-виджет, связанную с ридером документа. |
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) у этого экземпляра ComboBoxField. |
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). |
Clone() | Поверхностное клонирование — копирует скалярное/совместно используемое ссылочное состояние. |
