Form
Обзор
Form — класс в Aspose.PDF FOSS для .NET. Наследуется от: ICollection<Aspose.Pdf.Annotations.WidgetAnnotation>.
Представляет интерактивную форму (AcroForm) PDF-документа.
Этот класс предоставляет 37 методов для работы с объектами Form в программах .NET. Доступные методы включают: Add, AddFieldAppearance, AssignXfa, CopyTo, Delete, ExportFdf, ExportToJson, ExportXfdf, FindByName, FindField, Flatten, Form и ещё 15 методов. Все публичные члены доступны любому приложению .NET после установки пакета Aspose.PDF FOSS для .NET. Свойства: AutoRecalculate, AutoRestoreForm, CalculatedFields, Count, DefaultAppearance, DefaultResources и ещё 14.
Свойства
| Имя: | Тип: | Доступ | Описание: |
|---|---|---|---|
HasXfa | bool | Чтение | True, когда форма содержит часть XFA. |
AutoRecalculate | bool | Чтение/запись | Если true, пересчитывать вычисляемые поля при каждом изменении зависимости. |
AutoRestoreForm | bool | Чтение/запись | Восстанавливает ли форма свои поля из виджетов страниц, когда запись AcroForm /Fields отсутствует/пустая (по умолчанию true). |
CalculatedFields | IEnumerable<Field>? | Чтение/запись | Порядок полей, используемый для выполнения проходов расчётов. |
DefaultAppearance | Aspose.Pdf.Annotations.DefaultAppearance | Чтение/запись | Стандартный внешний вид, применяемый к полям, у которых нет собственного /DA. |
DefaultResources | Aspose.Pdf.Resources? | Чтение | Ресурсы шрифта/цветового пространства по умолчанию, используемые в форме. |
IsSynchronized | bool | Чтение | Является ли базовая коллекция потокобезопасной. |
NeedsRendering | bool | Чтение | Истина, когда у формы установлен флаг NeedsAppearances. |
RemovePermission | bool | Чтение/запись | Если истинно, биты прав доступа документа удаляются перед сохранением. |
SignaturesAppendOnly | bool | Чтение/запись | Если true, writer игнорирует модификации, обходящие подпись. |
SyncRoot | object | Чтение | Корневой объект синхронизации для IsSynchronized. |
Type | FormType | Чтение/запись | Тип формы (Standard, Static, Dynamic). |
IsXfa | bool | Чтение | Является ли эта форма XFA-формой. |
XFA | XFA? | Чтение | XFA accessor, раскрывающий базовые пакеты XML (template, datasets, …). |
Fields | Field[] | Чтение | Возвращает поля формы в виде массива snapshot. |
IgnoreNeedsRendering | bool | Чтение/запись | Если истинно, запись NeedAppearances формы подавляется, чтобы Acrobat не восстанавливал внешний вид виджетов при открытии. |
EmulateRequierdGroups | bool | Чтение/запись | Когда истинно, шаг уплощения формы добавляет синтетический маркер Required для XFA-стильных ‘requiredGroups’, у которых не выполнено ограничение at-least-one-required. |
Count | int | Чтение | Количество корневых полей формы — элементы массива AcroForm /Fields (поля, у которых field-/Parent равен null). |
RadioGroups | IReadOnlyList<RadioButtonGroup> | Чтение | Все группы радиокнопок в форме. |
SignaturesExist | bool | Чтение/запись | Истина, если в этой форме существует любое поле подписи с ненулевым словарём подписи /V. |
Методы
| Подпись | Описание: |
|---|---|
GetEnumerator() | Вызывает GetEnumerator у данного экземпляра Form. |
Add(field: Field, partialName: string, pageNumber: int) | Копировать поле в форму под новым частичным именем, привязывая его виджеты к pageNumber. |
AddFieldAppearance(field: Field, pageNumber: int, rect: Rectangle) | Добавить новое отображение виджета к полю на определённой странице внутри прямоугольника. |
AssignXfa(xml: XmlDocument) | Заменить наборы данных XFA из данного XmlDocument. |
CopyTo(array: Field[], index: int) | Скопировать поля в предоставленный массив, начиная с индекса. |
Delete(field: Field) | Удалить предоставленное поле из формы. |
ExportToJson(stream: Stream) | Сериализовать поля формы в JSON через предоставленный поток. |
ExportToJson(fileName: string) | Сериализовать поля формы в JSON в файле. |
ExportToJson(stream: Stream, options: ExportFieldsToJsonOptions?) | Сериализовать поля формы в JSON через предоставленный поток. |
ExportToJson(fileName: string, options: ExportFieldsToJsonOptions?) | Сериализовать поля формы в JSON в файле. |
GetFieldsInRect(rect: Rectangle) | Вернуть поля, которые пересекают заданный прямоугольник. |
HasField(field: Field) | Истина, когда предоставленное поле принадлежит этой форме. |
ImportFromJson(stream: Stream) | Считайте значения полей формы из потока JSON и примените их. |
ImportFromJson(fileName: string) | Считайте значения полей формы из файла JSON и примените их. |
MakeFormAnnotationsIndependent(page: Page) | Отсоедините аннотации формы от дерева полей, чтобы их можно было перемещать между страницами независимо. |
RemoveFieldAppearance(field: Field, appearanceIndex: int) | Удалите конкретную запись отображения из поля. |
GetXfaDatasetsXml() | Получить наборы данных XFA XML, или null, если это не форма XFA. |
ExportFdf() | Экспортировать данные полей формы в FDF (Forms Data Format) согласно спецификации PDF §12.7.7. |
ImportFdf(fdfData: byte[]) | Импортировать данные полей формы из байтов FDF. |
ExportXfdf() | Экспортировать данные полей формы в XFDF (XML Forms Data Format). |
ImportXfdf(xfdfXml: string) | Импортировать данные полей формы из строки XFDF XML. |
GetXfaFieldValue(path: string) | Получить значение поля XFA по точечному пути в наборах данных XML. |
SetXfaFieldValue(path: string, value: string) | Установите значение поля XFA по точечному пути в наборах данных XML. |
SetXfaFieldValues(values: IReadOnlyList<KeyValuePair<string, string>>) | Установите несколько значений полей XFA за один цикл разбора/сериализации наборов данных. |
SetXfaFieldImage(path: string, base64: string, contentType: string) | Запишите изображение в формате base64 в узел XFA datasets для пути и пометьте его указанным contentType (например, |
Flatten() | Сведите все поля формы к плоскому виду — отрендерьте их визуальное представление в содержимое страницы и удалите интерактивную форму. |
Flatten(document: Document) | Сведите все поля формы к плоскому виду — отрендерьте их визуальное представление в содержимое страницы и удалите интерактивную форму. |
Form(document: Document) | Создать форму, привязанную к документу. |
Delete(fieldName: string) | Удалить поле формы по имени. |
Add(field: Field) | Добавьте поле в форму на указанной странице. |
Add(field: Field, pageNumber: int) | Поле, которое нужно добавить. |
findField(fullName: string) | Ищет поле по имени; возвращает null, если не найдено. |
FindField(fullName: string) | PascalCase псевдоним findField. |
ToObject() | Экспортировать все значения полей как словарь (имя поля → значение). |
HasField(fieldName: string) | Истина, если поле с указанным полным именем существует в AcroForm. |
HasField(fieldName: string, searchChildren: bool) | Истина, если поле с указанным именем существует. |
FindByName(fullName: string) | Найдите поле по его полному имени или по пути XFA для статических форм XFA. |
