Field
Обзор
Field — это класс в Aspose.PDF FOSS для .NET. Наследуется от: Aspose.Pdf.Annotations.WidgetAnnotation, IEnumerable<Aspose.Pdf.Annotations.WidgetAnnotation>.
Представляет поле формы.
Этот класс предоставляет 26 методов для работы с объектами Field в программах .NET. Доступные методы включают: Accept, ChangeAfterResize, Clone, CopyTo, ExecuteFieldJavaScript, ExportToJson, ExportValueToJson, Field, Flatten, GetCheckedStateName, GetEnumerator, GetRectangle и 7 дополнительных методов. Все публичные члены доступны любому приложению .NET после установки пакета Aspose.PDF FOSS для .NET. Свойства: Action, Actions, ActiveState, Alignment, AlternateName, AnnotationFlags и ещё 72.
Свойства
| Имя: | Тип: | Доступ | Описание: |
|---|---|---|---|
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). |
Value | string? | Чтение/запись | Значение поля (/V). |
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 | Чтение/запись | 1-позиция вкладки виджета этого поля в массиве /Annots его страницы — порядок массива соответствует порядку вкладок страницы. |
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 запись). |
Parent | Forms.Field? | Чтение | Родительское поле, когда этот виджет является визуальным дочерним элементом поля AcroForm. |
Required | bool | Чтение/запись | Определяет, должно ли поле быть заполнено перед отправкой (/Ff бит 2). |
HighlightMode | string | Чтение | Режим подсветки (запись /H). |
DefaultAppearanceString | string? | Чтение | Строка внешнего вида по умолчанию (запись /DA). |
FieldValue | string? | Чтение | Значение поля (запись /V). |
DefaultFieldValue | string? | Чтение | Значение поля по умолчанию (/DV entry). |
FieldType | string? | Чтение | Тип поля (/FT entry). |
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). |
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. |
Методы
| Подпись | Описание: |
|---|---|
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) у этого экземпляра Field. |
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() | Поверхностное клонирование — копирует скалярное/разделяемое ссылками состояние. |
