FormEditor
Vue d’ensemble
FormEditor est une classe dans Aspose.PDF FOSS pour .NET.
Hérite de : IDisposable.
Façade pour les opérations de formulaire : remplir les champs, aplatir les formulaires, importer/exporter des données.
Cette classe fournit 64 méthodes pour travailler avec des objets FormEditor dans les programmes .NET.
Méthodes disponibles : AddCheckBox, AddField, AddFieldScript, AddListItem, AddSubmitBtn, AddTextField, BindPdf, CheckField, Close, CopyInnerField, CopyOuterField, DecorateField, et 34 méthodes supplémentaires.
Tous les membres publics sont accessibles à toute application .NET après l’installation du package Aspose.PDF FOSS for .NET.
Propriétés : ConvertTo, DestFileName, DestStream, ExportItems, Facade, Items, et 6 autres.
Propriétés
| Nom | Type | Accès | Description |
|---|---|---|---|
SrcFileName | string? | Read/Write | Chemin du fichier source utilisé par le constructeur sans paramètres + le flux Save. |
SrcStream | Stream? | Read/Write | Flux source utilisé par le constructeur sans paramètres + le flux Save. |
DestFileName | string? | Read/Write | Chemin du fichier de destination écrit par Save() sans paramètres. |
DestStream | Stream? | Read/Write | Flux de destination écrit par Save() sans paramètres. |
ConvertTo | PdfFormat | Read/Write | Version cible PDF/A ou PDF pour la sortie enregistrée. |
Facade | FormFieldFacade | Read/Write | Aspect visuel appliqué par AddField et DecorateField(). |
Items | string[]? | Read/Write | Liste par défaut d’éléments utilisée par AddField lors de la création de champs ListBox / ComboBox. |
ExportItems | string[][]? | Read/Write | Paires valeur d’exportation associées aux éléments. |
RadioButtonItemSize | double | Read/Write | Longueur du bord de l’élément bouton radio (en points) utilisée lors de la disposition d’un groupe de boutons radio. |
RadioGap | float | Read/Write | Écart (en points) entre les éléments bouton radio dans un groupe. |
RadioHoriz | bool | Read/Write | Lorsque vrai, les éléments bouton radio sont disposés horizontalement ; sinon verticalement. |
SubmitFlag | SubmitFormFlag | Read/Write | Format de soumission utilisé par AddSubmitBtn et SetSubmitFlag. |
Méthodes
| Signature | Description |
|---|---|
FormEditor() | Constructeur par défaut pour l’API sans état basée sur byte[] |
FormEditor(document: Document) | Lier l’éditeur à un document pour des opérations sur place |
FormEditor(document: Document, destStream: Stream) | Lier un document et préconfigurer un flux de sortie pour le Save sans paramètre |
FormEditor(document: Document, destFileName: string) | Lier un document et préconfigurer un chemin de fichier de sortie pour le Save sans paramètre |
FormEditor(srcStream: Stream, destStream: Stream) | Ouvrir depuis un flux d’entrée, écrire vers un flux de sortie lors du Save |
FormEditor(srcFileName: string, destFileName: string) | Ouvrir depuis un fichier d’entrée, écrire vers un fichier de sortie lors du Save |
BindPdf(path: string) | Lier un fichier PDF par chemin pour l’édition |
BindPdf(pdfData: byte[]) | Lier un PDF depuis un tampon d’octets |
BindPdf(stream: Stream) | Lier un PDF depuis un flux |
BindPdf(document: Document) | Lier un PDF depuis un Document déjà ouvert |
Save(path: string) | Enregistrer le document lié vers un chemin de fichier |
Save(destStream: Stream) | Enregistrer le document lié vers un flux |
Save() | Enregistrer le document lié vers la destination configurée (DestFileName ou DestStream) |
Close() | Fermer et libérer le document lié |
Dispose() | Appeler Dispose sur cette instance de FormEditor |
SetField(fieldName: string, value: string) | Définir la valeur d’un champ par son nom |
CheckField(fieldName: string) | Cocher une case à cocher par son nom |
UncheckField(fieldName: string) | Décocher une case à cocher par son nom |
AddTextField(fieldName: string, pageNumber: int, llx: double, lly: double, urx: double, ury: double) | Ajouter un champ texte au document lié |
AddCheckBox(fieldName: string, pageNumber: int, llx: double, lly: double, urx: double, ury: double, isChecked: bool) | Ajouter un champ case à cocher au document lié |
AddField(fieldType: FieldType, fieldName: string, pageNum: int, llx: float, lly: float, urx: float, ury: float) | Ajouter un champ du type fieldType donné au rectangle demandé sur pageNum |
AddField(fieldType: FieldType, fieldName: string, initValue: string?, pageNum: int, llx: float, lly: float, urx: float, ury: float) | Ajouter un champ avec une valeur initiale (champs texte et listes déroulantes) |
AddListItem(fieldName: string, itemName: string) | Ajouter un élément unique à un champ ListBox / ComboBox |
AddListItem(fieldName: string, exportName: string[]) | Ajouter un élément unique avec une paire valeur d’exportation (affichage, export) |
DelListItem(fieldName: string, itemName: string) | Supprimer un élément unique d’un champ ListBox / ComboBox |
AddSubmitBtn(fieldName: string, page: int, label: string, url: string, llx: float, lly: float, urx: float, ury: float) | Ajouter un bouton Submit |
AddFieldScript(fieldName: string, script: string) | Attacher un script d’action JavaScript à un champ |
SetFieldScript(fieldName: string, script: string) | Remplacer le script d’action JavaScript du champ |
CopyInnerField(fieldName: string, newFieldName: string, pageNum: int) | Copier un champ dans le document lié vers une autre page |
CopyInnerField(fieldName: string, newFieldName: string, pageNum: int, abscissa: float, ordinate: float) | Copier un champ dans le document lié vers une autre page aux coordonnées données |
CopyOuterField(srcFileName: string, fieldName: string) | Copier un champ d’un autre fichier PDF dans le document lié à la même position |
CopyOuterField(srcFileName: string, fieldName: string, pageNum: int) | Copier un champ d’un autre fichier PDF dans le document lié à une page spécifiée |
CopyOuterField(srcFileName: string, fieldName: string, pageNum: int, abscissa: float, ordinate: float) | Copier un champ d’un autre fichier PDF à des coordonnées explicites |
DecorateField() | Appliquer Facade à chaque champ du document |
DecorateField(fieldType: FieldType) | Appliquer Facade à chaque champ du type donné |
DecorateField(fieldName: string) | Appliquer Facade à un seul champ nommé |
ResetFacade() | Réinitialiser chaque propriété sur Facade |
ResetInnerFacade() | Alias pour ResetFacade couvrant les appelants de façade imbriquée |
MoveField(fieldName: string, llx: float, lly: float, urx: float, ury: float) | Déplacer la boîte englobante d’un champ |
RenameField(fieldName: string, newFieldName: string) | Renommer un champ de formulaire |
RemoveField(fieldName: string) | Supprimer un champ par son nom |
RemoveFieldAction(fieldName: string) | Supprimer l’action attachée à un champ |
SetFieldAlignment(fieldName: string, alignment: int) | Définir l’alignement horizontal de la valeur d’un champ |
SetFieldAlignmentV(fieldName: string, alignment: int) | Définir l’alignement vertical de la valeur d’un champ |
SetFieldAppearance(fieldName: string, flags: AnnotationFlags) | Définir les indicateurs de visibilité / lecture seule / obligatoire sur un champ |
GetFieldAppearance(fieldName: string) | Retourner les indicateurs de visibilité / lecture seule / obligatoire d’un champ |
SetFieldAttribute(fieldName: string, flag: PropertyFlag) | Définir ReadOnly / Required / NoExport |
SetFieldCombNumber(fieldName: string, combNumber: int) | Définir le nombre de cellules de combinaison pour un champ texte (PDF 1.5+) |
SetFieldLimit(fieldName: string, fieldLimit: int) | Définir le nombre maximal de caractères d’un champ texte par son nom |
SetSubmitFlag(fieldName: string, submitFormFlag: SubmitFormFlag) | Définir l’indicateur d’action SubmitForm sur un champ bouton |
SetSubmitUrl(fieldName: string, url: string) | Définir l’URL cible de l’action SubmitForm sur un champ bouton |
Single2Multiple(fieldName: string) | Convertir un champ texte à ligne unique en champ texte multi‑ligne |
FlattenAllFields() | Aplatir tous les champs de formulaire dans le document lié |
FillFields(input: byte[], fieldValues: Dictionary<string, string>) | Remplir les champs de formulaire avec les valeurs données (nom du champ → valeur) |
FillField(input: byte[], fieldName: string, value: string) | Remplir un seul champ de formulaire par son nom |
FlattenForm(input: byte[]) | Aplatir le formulaire — rendre les champs comme contenu statique et supprimer l’AcroForm |
GetFieldNames(input: byte[]) | Obtenir tous les noms de champs du formulaire du document |
GetFieldValue(input: byte[], fieldName: string) | Obtenir la valeur d’un champ spécifique |
GetFieldType(input: byte[], fieldName: string) | Obtenir le type d’un champ spécifique |
HasForm(input: byte[]) | Vérifier si le document possède un formulaire |
GetFieldCount(input: byte[]) | Obtenir le nombre total de champs de formulaire |
ExportFormData(input: byte[]) | Exporter les données du formulaire sous forme de dictionnaire (nom du champ → valeur) |
ImportFormData(input: byte[], data: Dictionary<string, string>) | Importer les données du formulaire depuis un dictionnaire |
RenameField(input: byte[], oldName: string, newPartialName: string) | Renommer un champ de formulaire dans les octets fournis |
