Procédure d'accès aux données de formulaire en utilisant le modèle objet InfoPath 2003

Pour rendre un formulaire InfoPath plus performant, il est souvent nécessaire d'accéder par programme aux informations sur le document XML sous-jacent du formulaire et aux données qu'il contient ou d'exécuter certaines actions sur le document XML. Le modèle objet d'InfoPath prend en charge l'accès et la manipulation du document XML sous-jacent d'un formulaire grâce à l'utilisation de l'interface XDocument en combinaison avec l'interface XDocumentsCollection.

L'interface XDocument est l'un des types les plus utiles du modèle objet d'InfoPath parce qu'il fournit un éventail de propriétés, de méthodes et d'événements qui non seulement interagissent avec le document XML sous-jacent d'un formulaire, mais exécutent aussi la plupart des actions disponibles dans l'interface utilisateur d'InfoPath. Dans un projet avec code managé créé avec le modèle objet compatible avec InfoPath 2003, une variable de type XDocument appelée thisXDocument est automatiquement définie dans la méthode _StartUp de la classe qui contient les gestionnaires d'événements dans le code de formulaire de votre projet. Vous pouvez utiliser la variable thisXDocument dans le code du formulaire pour accéder à l'interface XDocument et à ses membres.

Vue d'ensemble de l'interface XDocumentsCollection

L'interface XDocumentsCollection fournit aux développeurs de formulaires les méthodes et les propriétés suivantes pour gérer les objets XDocument que contient la collection.

Nom	Description
Méthode Close	Ferme le formulaire spécifié.
Méthode New	Crée un nouveau formulaire basé sur un formulaire existant.
Méthode NewFromSolution	Crée un nouveau formulaire basé sur un formulaire existant.
Méthode NewFromSolutionWithData	Crée un formulaire InfoPath en utilisant le modèle de formulaire et les données XML spécifiés.
Méthode Open	Ouvre le formulaire spécifié.
Propriété Count	Renvoie le nombre d'objets XDocument que contient la collection.
Propriété Item	Renvoie une référence à l'objet XDocument spécifié.

Vue d'ensemble de l'interface XDocument

L'interface XDocument fournit aux développeurs de formulaires les méthodes et les propriétés suivantes pour interagir et exécuter des actions sur le document XML sous-jacent d'un formulaire.

Nom	Description
Méthode GetDataVariable	Renvoie la valeur chaîne d'une variable de données spécifiée.
Méthode GetDOM	Renvoie une référence au DOM (Document Object Model) XML associé à l'objet DataObject spécifié.
Méthode ImportFile	Importe (ou fusionne) le formulaire spécifié dans le formulaire actif.
Méthode PrintOut	Imprime la vue actuelle d'un formulaire.
Méthode Query	Récupère les données de l'adaptateur de données associé à un formulaire.
Méthode Save	Enregistre le formulaire actif.
Méthode SaveAs	Enregistre le formulaire actif sous le nom spécifié.
Méthode SetDataVariable	Définit la valeur d'une variable de données spécifiée.
Méthode Submit	Envoie un formulaire selon les paramètres définis en mode Création.
Propriété DataObjects	Renvoie une référence à la collection DataObjects.
Propriété DOM	Renvoie une référence au DOM XML rempli par les données XML source d'un formulaire.
Propriété Errors	Renvoie une référence à la collection Errors.
Propriété Extension	Renvoie une référence à un objet représentant l'ensemble des fonctions et des variables contenues dans le fichier de code de formulaire.
Propriété IsDirty	Renvoie une valeur Boolean indiquant si les données du formulaire ont été modifiées.
Propriété IsDOMReadOnly	Renvoie une valeur Boolean indiquant si le DOM XML est défini en lecture seule.
Propriété IsNew	Renvoie une valeur Boolean indiquant si le formulaire a été enregistré après sa création.
Propriété IsReadOnly	Renvoie une valeur Boolean indiquant si le formulaire est en mode lecture seule.
Propriété IsSigned	Renvoie une valeur Boolean indiquant si le formulaire est signé numériquement.
Propriété Language	Spécifie ou renvoie la valeur chaîne du langage utilisé pour le formulaire.
Propriété QueryAdapter	Renvoie une référence à l'objet adaptateur de données.
Propriété Solution	Renvoie une référence à l'objet Solution.
Propriété UI	Renvoie une référence à l'objet UI.
Propriété URI	Renvoie une valeur chaîne contenant l'URI (Uniform Resource Identifier) du formulaire.
Propriété View	Renvoie une référence à l'objet View.
Propriété ViewInfos	Renvoie une référence à la collection ViewInfos.

Utilisation de la collection XDocuments et des interfaces XDocument

L'interface XDocumentsCollection est accessible via la propriété XDocuments de l'interface Application. Dans un projet avec code managé créé en utilisant le modèle objet compatible avec InfoPath 2003, vous pouvez accéder à l'interface XDocumentsCollection à l'aide de la variable thisApplication instanciée dans la méthode _StartUp du code de formulaire de votre projet. Les lignes de code qui suivent créent une variable qui fait référence à l'interface XDocumentsCollection du projet actuel.

XDocumentsCollection xdocs;
xdocs = thisApplication.XDocuments;

// Write code here to work with the XDocumentsCollection.

Dim xdocs As XDocumentsCollection
xdocs = thisApplication.XDocuments

' Write code here to work with the XDocumentsCollection.

Dans un projet avec code managé créé en utilisant le modèle objet compatible avec InfoPath 2003, vous pouvez accéder à l'interface XDocument via la variable thisXDocument instanciée dans la méthode StartUp du code de formulaire de votre projet. La ligne de code qui suit utilise la variable thisXDocument pour accéder à l'interface XDocument du projet actuel et afficher l'URI du formulaire ouvert dans un message d'alerte.

thisXDocument.UI.Alert(thisXDocument.URI);

thisXDocument.UI.Alert(thisXDocument.URI)

Remarque
Lorsque vous utilisez l'interface XDocument pour accéder au document XML sous-jacent d'un formulaire, vous accédez au document XML associé au formulaire ouvert.

La propriété DOM est une des propriétés clés de l'objet XDocument. Cette propriété renvoie une référence au DOM XML rempli par les données XML source d'un formulaire. Lorsque vous utilisez la propriété DOM, vous pouvez utiliser l'ensemble des propriétés et des méthodes prises en charge par le DOM XML. Par exemple, le code suivant utilise la propriété xml du DOM XML pour renvoyer et afficher le contenu complet du document XML sous-jacent d'un formulaire :

string xmldoc;
xmldoc = thisXDocument.DOM.xml;
// Display xml.
thisXDocument.UI.Alert(xmldoc);

Dim xmldoc As String
xmldoc = thisXDocument.DOM.xml
' Display xml.
thisXDocument.UI.Alert(xmldoc)

Remarque
Pour en savoir plus sur le DOM XML et sur toutes les propriétés et méthodes qu'il prend en charge, consultez la documentation du kit de développement MSXML 5.0 (en anglais uniquement) dans le système d'aide de Microsoft Script Editor (MSE).