Formular
Übersicht
Form ist eine Klasse in Aspose.PDF FOSS für .NET.
Erbt von: IEnumerable<Aspose.Pdf.Annotations.WidgetAnnotation>.
Stellt das interaktive Formular (AcroForm) eines PDF-Dokuments dar.
Diese Klasse bietet 36 Methoden zur Arbeit mit Form‑Objekten in .NET‑Programmen.
Verfügbare Methoden umfassen: Add, AddFieldAppearance, AssignXfa, CopyTo, Delete, ExportFdf, ExportToJson, ExportXfdf, FindByName, FindField, Flatten, Form und 14 weitere Methoden.
Alle öffentlichen Mitglieder sind für jede .NET‑Anwendung nach der Installation des Aspose.PDF FOSS for .NET‑Pakets zugänglich.
Eigenschaften: AutoRecalculate, AutoRestoreForm, CalculatedFields, Count, DefaultAppearance, DefaultResources und 14 weitere.
Eigenschaften
| Name | Type | Access | Description |
|---|---|---|---|
Fields | Field[] | Lesen | Gibt die Formularfelder als ein Schnappschuss‑Array (Field[] Fields) zurück, sodass Aufrufer .Length und Array‑Indexierung verwenden können. |
IgnoreNeedsRendering | bool | Lesen/Schreiben | Wenn true, wird der NeedAppearances‑Eintrag des Formulars unterdrückt, sodass Acrobat die Widget‑Darstellungen beim Öffnen nicht neu erstellt. |
EmulateRequierdGroups | bool | Lesen/Schreiben | Wenn true, fügt der Flatten‑Schritt des Formulars einen synthetischen Required‑Marker für XFA‑artige ‘requiredGroups’ hinzu, deren mindestens‑ein‑erforderlich‑Constraint nicht erfüllt ist. |
Count | int | Lesen | Gibt die Anzahl zurück. |
RadioGroups | IReadOnlyList<RadioButtonGroup> | Lesen | Alle Radio‑Button‑Gruppen im Formular. |
SignaturesExist | bool | Lesen/Schreiben | True, wenn ein Signaturfeld mit einem nicht‑null /V Signatur‑Dictionary in diesem Formular existiert. |
Type | FormType | Lesen/Schreiben | Der Formulartyp (Standard, Static, Dynamic). |
IsXfa | bool | Lesen | Ob dieses Formular ein XFA‑Formular ist. |
XFA | XFA? | Lesen | XFA‑Accessor, der die zugrunde liegenden XML‑Pakete (Template, Datasets, …) bereitstellt. |
HasXfa | bool | Lesen | True, wenn das Formular einen XFA‑Teil enthält. |
AutoRecalculate | bool | Lesen/Schreiben | Wenn true, berechnet berechnete Felder neu, sobald eine Abhängigkeit sich ändert. |
AutoRestoreForm | bool | Lesen/Schreiben | Wenn true, stellt das Formular seine Standardwerte beim Zurücksetzen automatisch wieder her. |
CalculatedFields | IEnumerable<Field>? | Lesen/Schreiben | Die Feldreihenfolge, die für Berechnungsdurchläufe verwendet wird. |
DefaultAppearance | Aspose.Pdf.Annotations.DefaultAppearance | Lesen/Schreiben | Standard‑Darstellung, die auf Felder angewendet wird, die kein eigenes /DA besitzen. |
DefaultResources | Aspose.Pdf.Resources? | Lesen | Standard‑Schrift‑/Farbraum‑Ressourcen, die vom Formular verwendet werden. |
IsSynchronized | bool | Lesen | Ob die zugrunde liegende Sammlung Thread‑sicher ist. |
NeedsRendering | bool | Lesen | True, wenn das Formular das NeedsAppearances‑Flag gesetzt hat. |
RemovePermission | bool | Lesen/Schreiben | Wenn true, werden die Berechtigungsbits des Dokuments vor dem Speichern entfernt. |
SignaturesAppendOnly | bool | Lesen/Schreiben | Wenn true, ignoriert der Writer signatur‑umgehende Änderungen. |
SyncRoot | object | Lesen | Synchronisations‑Stammobjekt für IsSynchronized. |
Methoden
| Signature | Description |
|---|---|
Form(document: Document) | Erzeugt ein Form, das an das Dokument gebunden ist. |
Delete(fieldName: string) | Löscht ein Formularfeld nach Namen. |
Add(field: Field) | Fügt ein Feld dem Formular auf der angegebenen Seite hinzu. |
Add(field: Field, pageNumber: int) | Das hinzuzufügende Feld. |
findField(fullName: string) | Sucht ein Feld nach Namen; gibt null zurück, wenn nicht gefunden. |
FindField(fullName: string) | PascalCase-Alias von findField. |
ToObject() | Exportiert alle Feldwerte als Wörterbuch (Feldname → Wert). |
HasField(fieldName: string) | True, wenn ein Feld mit dem angegebenen vollständigen Namen im AcroForm existiert. |
HasField(fieldName: string, searchChildren: bool) | True, wenn ein Feld mit dem angegebenen Namen existiert. |
FindByName(fullName: string) | Findet ein Feld nach seinem vollständigen Namen oder nach XFA-Pfad für statische XFA-Formulare. |
GetXfaDatasetsXml() | Gibt das XFA-Datensatz-XML zurück oder null, wenn es kein XFA-Formular ist. |
GetXfaFieldValue(path: string) | Liefert einen XFA-Feldwert anhand eines punktierten Pfads im Datensatz-XML. |
SetXfaFieldValue(path: string, value: string) | Setzt einen XFA-Feldwert anhand eines punktierten Pfads im Datensatz-XML. |
SetXfaFieldValues(values: IReadOnlyList<KeyValuePair<string, string>>) | Setzt mehrere XFA-Feldwerte in einem Datensatz‑Parse/Serialisierungszyklus. |
Flatten() | Flacht alle Formularfelder ab – rendert ihr visuelles Erscheinungsbild in den Seiteninhalt und entfernt das interaktive Formular. |
Flatten(document: Document) | Flacht alle Formularfelder ab – rendert ihr visuelles Erscheinungsbild in den Seiteninhalt und entfernt das interaktive Formular. |
ExportFdf() | Exportiert Formulardaten im FDF (Forms Data Format) gemäß PDF‑Spezifikation §12.7.7. |
ImportFdf(fdfData: byte[]) | Importiert Formulardaten aus FDF‑Bytes. |
ExportXfdf() | Exportiert Formulardaten im XFDF (XML Forms Data Format). |
ImportXfdf(xfdfXml: string) | Importiert Formulardaten aus einem XFDF‑XML‑String. |
GetEnumerator() | Ruft GetEnumerator für diese Form‑Instanz auf. |
Add(field: Field, partialName: string, pageNumber: int) | Kopiert ein Feld in das Formular unter einem neuen Teilnamen und bindet dessen Widget(s) an pageNumber. |
AddFieldAppearance(field: Field, pageNumber: int, rect: Rectangle) | Fügt einem Feld auf einer bestimmten Seite innerhalb eines Rechtecks ein neues Widget‑Erscheinungsbild hinzu. |
AssignXfa(xml: XmlDocument) | Ersetzt die XFA‑Datensätze durch das angegebene XmlDocument. |
CopyTo(array: Field[], index: int) | Kopiert Felder in das bereitgestellte Array, beginnend bei index. |
Delete(field: Field) | Entfernt das bereitgestellte Feld aus dem Formular. |
ExportToJson(stream: Stream) | Serialisiert die Felder des Formulars in JSON über den bereitgestellten Stream. |
ExportToJson(fileName: string) | Serialisiert die Felder des Formulars in JSON in einer Datei. |
ExportToJson(stream: Stream, options: ExportFieldsToJsonOptions?) | Serialisiert die Felder des Formulars in JSON über den bereitgestellten Stream. |
ExportToJson(fileName: string, options: ExportFieldsToJsonOptions?) | Serialisiert die Felder des Formulars in JSON in einer Datei. |
GetFieldsInRect(rect: Rectangle) | Gibt die Felder zurück, die das bereitgestellte Rechteck schneiden. |
HasField(field: Field) | True, wenn das bereitgestellte Feld zu diesem Formular gehört. |
ImportFromJson(stream: Stream) | Liest Formulardaten aus einem JSON‑Stream und wendet sie an. |
ImportFromJson(fileName: string) | Liest Formulardaten aus einer JSON‑Datei und wendet sie an. |
MakeFormAnnotationsIndependent(page: Page) | Löst Formularanmerkungen vom Feldbaum, sodass sie unabhängig zwischen Seiten verschoben werden können. |
RemoveFieldAppearance(field: Field, appearanceIndex: int) | Entfernt einen bestimmten Erscheinungseintrag aus einem Feld. |