Formular-Editor
Übersicht
FormEditor ist eine Klasse in Aspose.PDF FOSS für .NET.
Erbt von: IDisposable.
Fassade für Formularoperationen: Felder ausfüllen, Formulare flachlegen, Daten importieren/exportieren.
Diese Klasse bietet 64 Methoden zur Arbeit mit FormEditor‑Objekten in .NET‑Programmen.
Verfügbare Methoden umfassen: AddCheckBox, AddField, AddFieldScript, AddListItem, AddSubmitBtn, AddTextField, BindPdf, CheckField, Close, CopyInnerField, CopyOuterField, DecorateField und 34 weitere Methoden.
Alle öffentlichen Mitglieder sind für jede .NET‑Anwendung nach der Installation des Aspose.PDF FOSS for .NET‑Pakets zugänglich.
Eigenschaften: ConvertTo, DestFileName, DestStream, ExportItems, Facade, Items und 6 weitere.
Eigenschaften
| Name | Typ | Zugriff | Beschreibung |
|---|---|---|---|
SrcFileName | string? | Read/Write | Quelldateipfad, der vom parameterlosen ctor + Save‑Ablauf verwendet wird. |
SrcStream | Stream? | Read/Write | Quellstream, der vom parameterlosen ctor + Save‑Ablauf verwendet wird. |
DestFileName | string? | Read/Write | Zieldateipfad, der vom parameterlosen Save() geschrieben wird. |
DestStream | Stream? | Read/Write | Zielstream, der vom parameterlosen Save() geschrieben wird. |
ConvertTo | PdfFormat | Read/Write | Ziel-PDF/A- oder PDF-Version für die gespeicherte Ausgabe. |
Facade | FormFieldFacade | Read/Write | Visuelles Erscheinungsbild, das von AddField und DecorateField() angewendet wird. |
Items | string[]? | Read/Write | Standardliste von Elementen, die von AddField beim Erstellen von ListBox‑/ComboBox‑Felder verwendet wird. |
ExportItems | string[][]? | Read/Write | Export‑Wert‑Paare, die mit Items verknüpft sind. |
RadioButtonItemSize | double | Read/Write | Kantenlänge des Radio‑Button‑Elements (in Punkten), die beim Layout einer Radio‑Gruppe verwendet wird. |
RadioGap | float | Read/Write | Abstand (in Punkten) zwischen Radio‑Button‑Elementen in einer Gruppe. |
RadioHoriz | bool | Read/Write | Wenn true, werden Radio‑Button‑Elemente horizontal angeordnet; andernfalls vertikal. |
SubmitFlag | SubmitFormFlag | Read/Write | Submit‑Format, das von AddSubmitBtn und SetSubmitFlag verwendet wird. |
Methoden
| Signatur | Beschreibung |
|---|---|
FormEditor() | Standardkonstruktor für zustandslose byte[]-basierte API. |
FormEditor(document: Document) | Den Editor an ein Dokument binden für In‑Place‑Operationen. |
FormEditor(document: Document, destStream: Stream) | Ein Dokument binden und einen Ausgabestream für das parameterlose Save vorab konfigurieren. |
FormEditor(document: Document, destFileName: string) | Ein Dokument binden und einen Ausgabepfad für das parameterlose Save vorab konfigurieren. |
FormEditor(srcStream: Stream, destStream: Stream) | Aus einem Eingabestream öffnen, beim Speichern in einen Ausgabestream schreiben. |
FormEditor(srcFileName: string, destFileName: string) | Aus einer Eingabedatei öffnen, beim Speichern in eine Ausgabedatei schreiben. |
BindPdf(path: string) | Eine PDF‑Datei per Pfad zum Bearbeiten binden. |
BindPdf(pdfData: byte[]) | Ein PDF aus einem Byte‑Puffer binden. |
BindPdf(stream: Stream) | Ein PDF aus einem Stream binden. |
BindPdf(document: Document) | Ein PDF aus einem bereits geöffneten Document binden. |
Save(path: string) | Das gebundene Dokument an einem Dateipfad speichern. |
Save(destStream: Stream) | Das gebundene Dokument in einen Stream speichern. |
Save() | Das gebundene Dokument am konfigurierten Ziel (DestFileName oder DestStream) speichern. |
Close() | Das gebundene Dokument schließen und freigeben. |
Dispose() | Ruft Dispose für diese FormEditor‑Instanz auf. |
SetField(fieldName: string, value: string) | Einen Feldwert nach Name setzen. |
CheckField(fieldName: string) | Ein Checkbox‑Feld nach Name aktivieren. |
UncheckField(fieldName: string) | Ein Checkbox‑Feld nach Name deaktivieren. |
AddTextField(fieldName: string, pageNumber: int, llx: double, lly: double, urx: double, ury: double) | Ein Textfeld zum gebundenen Dokument hinzufügen. |
AddCheckBox(fieldName: string, pageNumber: int, llx: double, lly: double, urx: double, ury: double, isChecked: bool) | Ein Checkbox‑Feld zum gebundenen Dokument hinzufügen. |
AddField(fieldType: FieldType, fieldName: string, pageNum: int, llx: float, lly: float, urx: float, ury: float) | Ein Feld des angegebenen fieldType im gewünschten Rechteck auf pageNum hinzufügen. |
AddField(fieldType: FieldType, fieldName: string, initValue: string?, pageNum: int, llx: float, lly: float, urx: float, ury: float) | Ein Feld mit einem Anfangswert hinzufügen (Textfelder und Kombinationsfelder). |
AddListItem(fieldName: string, itemName: string) | Ein einzelnes Element zu einem ListBox‑/ComboBox‑Feld hinzufügen. |
AddListItem(fieldName: string, exportName: string[]) | Ein einzelnes Element mit einem Export‑Wert‑Paar (Anzeige, Export) hinzufügen. |
DelListItem(fieldName: string, itemName: string) | Ein einzelnes Element aus einem ListBox‑/ComboBox‑Feld entfernen. |
AddSubmitBtn(fieldName: string, page: int, label: string, url: string, llx: float, lly: float, urx: float, ury: float) | Einen Submit‑Button hinzufügen. |
AddFieldScript(fieldName: string, script: string) | Ein JavaScript‑Aktionsskript an ein Feld anhängen. |
SetFieldScript(fieldName: string, script: string) | Das JavaScript‑Aktionsskript des Feldes ersetzen. |
CopyInnerField(fieldName: string, newFieldName: string, pageNum: int) | Ein Feld im gebundenen Dokument auf eine andere Seite kopieren. |
CopyInnerField(fieldName: string, newFieldName: string, pageNum: int, abscissa: float, ordinate: float) | Ein Feld im gebundenen Dokument auf eine andere Seite an den angegebenen Koordinaten kopieren. |
CopyOuterField(srcFileName: string, fieldName: string) | Ein Feld aus einer anderen PDF‑Datei in das gebundene Dokument an derselben Position kopieren. |
CopyOuterField(srcFileName: string, fieldName: string, pageNum: int) | Ein Feld aus einer anderen PDF‑Datei in das gebundene Dokument auf einer angegebenen Seite kopieren. |
CopyOuterField(srcFileName: string, fieldName: string, pageNum: int, abscissa: float, ordinate: float) | Ein Feld aus einer anderen PDF‑Datei an expliziten Koordinaten kopieren. |
DecorateField() | Facade auf jedes Feld im Dokument anwenden. |
DecorateField(fieldType: FieldType) | Facade auf jedes Feld des angegebenen Typs anwenden. |
DecorateField(fieldName: string) | Facade auf ein einzelnes benanntes Feld anwenden. |
ResetFacade() | Alle Eigenschaften von Facade zurücksetzen. |
ResetInnerFacade() | Alias für ResetFacade, der verschachtelte Facade‑Aufrufer abdeckt. |
MoveField(fieldName: string, llx: float, lly: float, urx: float, ury: float) | Die Begrenzungsbox eines Feldes verschieben. |
RenameField(fieldName: string, newFieldName: string) | Ein Formularfeld umbenennen. |
RemoveField(fieldName: string) | Ein Feld nach Name entfernen. |
RemoveFieldAction(fieldName: string) | Die an ein Feld angehängte Aktion entfernen. |
SetFieldAlignment(fieldName: string, alignment: int) | Die horizontale Ausrichtung des Feldwerts festlegen. |
SetFieldAlignmentV(fieldName: string, alignment: int) | Die vertikale Ausrichtung des Feldwerts festlegen. |
SetFieldAppearance(fieldName: string, flags: AnnotationFlags) | Die Sichtbarkeits‑/Schreibschutz‑/Erforderlich‑Flags eines Feldes setzen. |
GetFieldAppearance(fieldName: string) | Die Sichtbarkeits‑/Schreibschutz‑/Erforderlich‑Flags eines Feldes zurückgeben. |
SetFieldAttribute(fieldName: string, flag: PropertyFlag) | ReadOnly / Required / NoExport setzen. |
SetFieldCombNumber(fieldName: string, combNumber: int) | Die Comb‑Cell‑Anzahl für ein Textfeld festlegen (PDF 1.5+). |
SetFieldLimit(fieldName: string, fieldLimit: int) | Die maximale Zeichenanzahl eines Textfeldes nach Name festlegen. |
SetSubmitFlag(fieldName: string, submitFormFlag: SubmitFormFlag) | Das SubmitForm‑Aktions‑Flag bei einem Button‑Feld setzen. |
SetSubmitUrl(fieldName: string, url: string) | Die Ziel‑URL der SubmitForm‑Aktion bei einem Button‑Feld festlegen. |
Single2Multiple(fieldName: string) | Ein einzeiliges Textfeld in ein mehrzeiliges umwandeln. |
FlattenAllFields() | Alle Formularfelder im gebundenen Dokument flachlegen. |
FillFields(input: byte[], fieldValues: Dictionary<string, string>) | Formularfelder mit den angegebenen Werten füllen (Feldname → Wert). |
FillField(input: byte[], fieldName: string, value: string) | Ein einzelnes Formularfeld nach Name füllen. |
FlattenForm(input: byte[]) | Das Formular flachlegen — Felder als statischen Inhalt rendern und das AcroForm entfernen. |
GetFieldNames(input: byte[]) | Alle Feldnamen im Formular des Dokuments abrufen. |
GetFieldValue(input: byte[], fieldName: string) | Den Wert eines bestimmten Feldes abrufen. |
GetFieldType(input: byte[], fieldName: string) | Den Typ eines bestimmten Feldes abrufen. |
HasForm(input: byte[]) | Prüfen, ob das Dokument ein Formular enthält. |
GetFieldCount(input: byte[]) | Die Gesamtzahl der Formularfelder abrufen. |
ExportFormData(input: byte[]) | Formulardaten als Wörterbuch exportieren (Feldname → Wert). |
ImportFormData(input: byte[], data: Dictionary<string, string>) | Formulardaten aus einem Wörterbuch importieren. |
RenameField(input: byte[], oldName: string, newPartialName: string) | Ein Formularfeld in den bereitgestellten Bytes umbenennen. |