Formulaire

Vue d’ensemble

Form est une classe dans Aspose.PDF FOSS pour .NET.
Hérite de : IEnumerable<Aspose.Pdf.Annotations.WidgetAnnotation>.

Représente le formulaire interactif (AcroForm) d’un document PDF.

Cette classe fournit 36 méthodes pour travailler avec des objets Form dans les programmes .NET.
Les méthodes disponibles incluent : Add, AddFieldAppearance, AssignXfa, CopyTo, Delete, ExportFdf, ExportToJson, ExportXfdf, FindByName, FindField, Flatten, Form, et 14 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 : AutoRecalculate, AutoRestoreForm, CalculatedFields, Count, DefaultAppearance, DefaultResources, et 14 autres.

Propriétés

NomTypeAccèsDescription
FieldsField[]LectureRenvoie les champs du formulaire sous forme de tableau instantané (Field[] Fields), de sorte que les appelants puissent utiliser .Length et l’indexation de tableau.
IgnoreNeedsRenderingboolLecture/ÉcritureLorsque vrai, l’entrée NeedAppearances du formulaire est supprimée afin qu’Acrobat ne reconstruit pas les apparences des widgets à l’ouverture.
EmulateRequierdGroupsboolLecture/ÉcritureLorsque vrai, l’étape d’aplatissement du formulaire ajoute un marqueur Required synthétique pour les « requiredGroups » de style XFA dont la contrainte au moins-un-requis n’est pas satisfaite.
CountintLectureRenvoie le nombre.
RadioGroupsIReadOnlyList<RadioButtonGroup>LectureTous les groupes de boutons radio du formulaire.
SignaturesExistboolLecture/ÉcritureVrai si un champ de signature avec un dictionnaire de signature /V non nul existe dans ce formulaire.
TypeFormTypeLecture/ÉcritureLe type de formulaire (Standard, Static, Dynamic).
IsXfaboolLectureIndique si ce formulaire est un formulaire XFA.
XFAXFA?LectureAccesseur XFA exposant les paquets XML sous-jacents (template, datasets, …).
HasXfaboolLectureVrai lorsque le formulaire contient une partie XFA.
AutoRecalculateboolLecture/ÉcritureLorsque vrai, recalculer les champs calculés chaque fois qu’une dépendance change.
AutoRestoreFormboolLecture/ÉcritureLorsque vrai, le formulaire restaure automatiquement ses valeurs par défaut lors du Reset.
CalculatedFieldsIEnumerable<Field>?Lecture/ÉcritureL’ordre des champs utilisé pour piloter les passes de calcul.
DefaultAppearanceAspose.Pdf.Annotations.DefaultAppearanceLecture/ÉcritureApparence par défaut appliquée aux champs qui ne possèdent pas leur propre /DA.
DefaultResourcesAspose.Pdf.Resources?LectureRessources de police / espace couleur par défaut utilisées par le formulaire.
IsSynchronizedboolLectureIndique si la collection sous-jacente est thread-safe.
NeedsRenderingboolLectureVrai lorsque le formulaire a le drapeau NeedsAppearances activé.
RemovePermissionboolLecture/ÉcritureLorsque vrai, les bits de permission du document sont supprimés avant l’enregistrement.
SignaturesAppendOnlyboolLecture/ÉcritureLorsque vrai, l’écrivain ignore les modifications contournant la signature.
SyncRootobjectLectureObjet racine de synchronisation pour IsSynchronized.

Méthodes

SignatureDescription
Form(document: Document)Construire un Form lié au document.
Delete(fieldName: string)Supprimer un champ de formulaire par son nom.
Add(field: Field)Ajouter un champ au formulaire sur la page spécifiée.
Add(field: Field, pageNumber: int)Le champ à ajouter.
findField(fullName: string)Rechercher un champ par son nom ; renvoie null s’il n’est pas trouvé.
FindField(fullName: string)Alias PascalCase de findField.
ToObject()Exporter toutes les valeurs des champs sous forme de dictionnaire (field name → value).
HasField(fieldName: string)Vrai si un champ portant le nom complet indiqué existe dans l’AcroForm.
HasField(fieldName: string, searchChildren: bool)Vrai si un champ portant le nom indiqué existe.
FindByName(fullName: string)Trouver un champ par son nom complet, ou par le chemin XFA pour les formulaires XFA statiques.
GetXfaDatasetsXml()Obtenir le XML des jeux de données XFA, ou null si ce n’est pas un formulaire XFA.
GetXfaFieldValue(path: string)Obtenir la valeur d’un champ XFA via un chemin pointé dans le XML des jeux de données.
SetXfaFieldValue(path: string, value: string)Définir la valeur d’un champ XFA via un chemin pointé dans le XML des jeux de données.
SetXfaFieldValues(values: IReadOnlyList<KeyValuePair<string, string>>)Définir plusieurs valeurs de champs XFA en un seul cycle d’analyse/sérialisation des jeux de données.
Flatten()Aplatir tous les champs de formulaire — rendre leur apparence visuelle dans le contenu de la page et supprimer le formulaire interactif.
Flatten(document: Document)Aplatir tous les champs de formulaire — rendre leur apparence visuelle dans le contenu de la page et supprimer le formulaire interactif.
ExportFdf()Exporter les données des champs de formulaire au format FDF (Forms Data Format) selon la spécification PDF §12.7.7.
ImportFdf(fdfData: byte[])Importer les données des champs de formulaire à partir d’octets FDF.
ExportXfdf()Exporter les données des champs de formulaire au format XFDF (XML Forms Data Format).
ImportXfdf(xfdfXml: string)Importer les données des champs de formulaire à partir d’une chaîne XML XFDF.
GetEnumerator()Appelle GetEnumerator sur cette instance de Form.
Add(field: Field, partialName: string, pageNumber: int)Copier le champ dans le formulaire sous un nouveau nom partiel, en liant son(s) widget(s) au pageNumber.
AddFieldAppearance(field: Field, pageNumber: int, rect: Rectangle)Ajouter une nouvelle apparence de widget à un champ sur une page spécifique dans un rectangle.
AssignXfa(xml: XmlDocument)Remplacer les jeux de données XFA à partir du XmlDocument fourni.
CopyTo(array: Field[], index: int)Copier les champs dans le tableau fourni à partir de l’index.
Delete(field: Field)Supprimer le champ fourni du formulaire.
ExportToJson(stream: Stream)Sérialiser les champs du formulaire en JSON via le flux fourni.
ExportToJson(fileName: string)Sérialiser les champs du formulaire en JSON dans un fichier.
ExportToJson(stream: Stream, options: ExportFieldsToJsonOptions?)Sérialiser les champs du formulaire en JSON via le flux fourni.
ExportToJson(fileName: string, options: ExportFieldsToJsonOptions?)Sérialiser les champs du formulaire en JSON dans un fichier.
GetFieldsInRect(rect: Rectangle)Retourner les champs qui intersectent le rectangle fourni.
HasField(field: Field)Vrai lorsque le champ fourni appartient à ce formulaire.
ImportFromJson(stream: Stream)Lire les valeurs des champs de formulaire à partir d’un flux JSON et les appliquer.
ImportFromJson(fileName: string)Lire les valeurs des champs de formulaire à partir d’un fichier JSON et les appliquer.
MakeFormAnnotationsIndependent(page: Page)Détacher les annotations de formulaire de l’arbre des champs afin qu’elles puissent être déplacées entre les pages de façon indépendante.
RemoveFieldAppearance(field: Field, appearanceIndex: int)Supprimer une entrée d’apparence spécifique d’un champ.

Voir aussi

 Français