ListBoxField

Обзор

ListBoxField — это класс в Aspose.PDF FOSS для .NET. Наследует от: ChoiceField.

Поле формы списка — ChoiceField без флага Combo.

Этот класс предоставляет 35 методов для работы с объектами ListBoxField в программах .NET. Доступные методы включают: Accept, AddOption, ChangeAfterResize, ChoiceField, Clone, CopyTo, DeleteOption, ExecuteFieldJavaScript, ExportToJson, ExportValueToJson, Field, Flatten и ещё 11 методов. Все публичные члены доступны любой приложению .NET после установки пакета Aspose.PDF FOSS для .NET. Свойства: Action, Actions, ActiveState, Alignment, AlternateName, AnnotationFlags и ещё 84.

Свойства

Имя:	Тип:	Доступ	Описание:
`SelectedItems`	`int[]`	Чтение/запись	Массив selected-items только для установки.
`Selected`	`int`	Чтение/запись	Индекс выбранного варианта, начиная с 1 (-1, если нет); его установка выбирает единственный вариант.
`TopIndex`	`int`	Чтение/запись	Индекс, начинающийся с нуля, первого видимого пункта при прокрутке списка.
`IsCombo`	`bool`	Чтение	Получает значение `is combo`.
`IsEditable`	`bool`	Чтение	Получает значение свойства `is editable`.
`IsMultiSelect`	`bool`	Чтение	Получает значение is multi select.
`IsSorted`	`bool`	Чтение	Получает значение, указывающее, отсортировано ли.
`MultiSelect`	`bool`	Чтение/запись	Получить/установить MultiSelect (/Ff бит 22 — 0-based 21).
`CommitImmediately`	`bool`	Чтение/запись	Получить/установить CommitOnSelChange (/Ff бит 27 — 0-based 26).
`SelectedValues`	`IReadOnlyList<string>`	Чтение/запись	Текущие выбранные значения.
`SelectedIndices`	`IReadOnlyList<int>`	Чтение	Индексы выбранных значений, нумерация с нуля, в списке Options.
`Options`	`OptionCollection`	Чтение	Коллекция вариантов выбора.
`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 entry).
`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 внешнего вида по умолчанию как 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 бит 2).
`HighlightMode`	`string`	Чтение	Режим выделения (/H entry).
`DefaultAppearanceString`	`string?`	Чтение	Строка внешнего вида по умолчанию (/DA entry).
`FieldValue`	`string?`	Чтение	Значение поля (/V entry).
`DefaultFieldValue`	`string?`	Чтение	Значение поля по умолчанию (/DV entry).
`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 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 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-порядка, используемый рендерером DOM.

Методы

Подпись	Описание:
`ListBoxField()`	Конструктор без параметров (вызывающий привязывает к странице позже).
`ListBoxField(page: Page, rect: Rectangle)`	Создаёт новое поле списка на указанной странице с заданным прямоугольником.
`ListBoxField(doc: Document, rect: Rectangle)`	Создаёт новое поле списка, связанное с документом (страница назначается через Form.Add).
`ChoiceField(doc: Document)`	Вызывает ChoiceField(doc) у этого экземпляра ListBoxField.
`ChoiceField(doc: Document, rect: Rectangle)`	Вызывает ChoiceField(doc, rect) у этого экземпляра ListBoxField.
`ChoiceField(page: Page, rect: Rectangle)`	Вызывает ChoiceField(page, rect) у этого экземпляра ListBoxField.
`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 — создает пустую аннотацию виджета, связанную с doc’s reader.
`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) у этого экземпляра ListBoxField.
`GetRectangle(considerRotation: bool)`	Ограничивающий прямоугольник скорректирован с учётом considerRotation.
`ChangeAfterResize(transform: Matrix)`	Отрегулировать геометрию аннотации после того, как пользователь изменил размер страницы или хост-прямоугольника.
`UpdateAppearances()`	Сгенерировать заново поток обычного отображения (/AP /N) из текущей геометрии и colours аннотации.
`WriteXfdf(writer: System.Xml.XmlWriter)`	Сериализуйте эту аннотацию как элемент XFDF в writer (PDF 32000 §12.7.8 / XFDF 3.0).
`Clone()`	Поверхностное клонирование — копирует скалярное/общий-по-ссылке состояние.

См. также:

Aspose.PDF for .NET — Enterprise API Reference