XmlForm Classe

Définition

Espace de noms:

Microsoft.Office.InfoPath

Assembly:

Microsoft.Office.InfoPath.dll

Représente le document XML sous-jacent d'un formulaire.

public ref class XmlForm abstract

public abstract class XmlForm

type XmlForm = class

Public MustInherit Class XmlForm

Héritage

Object

XmlForm

Remarques

La XmlForm classe est un objet clé dans le modèle objet infoPath avec code managé qui fournit des propriétés, des méthodes et des événements qui peuvent être utilisés par programmation pour interagir avec et manipuler les données XML dans le document XML sous-jacent d’un formulaire.

Bien que XmlForm les objets soient accessibles à partir de la XmlFormCollection classe à l’aide de la XmlForms propriété de la classe, dans la Application plupart des cas, lorsque vous utilisez la logique métier du modèle de formulaire, vous accédez à la XmlForm classe et à ses membres à l’aide des mots clés this (en C#) ou Me (en Visual Basic) sans passer par la collection.

Par exemple, les exemples de code suivants de gestionnaires d’événements pour l’événement Loading utilisent les mots clés this ou Me pour accéder aux MainDataSource propriétés et NamespaceManager de la XmlForm classe . Ces propriétés sont utilisées pour travailler avec un instance du System.Xml. Champ employé XPath.XPathNavigator (résolution des préfixes d’espace de noms à l’aide de la NamespaceManager propriété ), puis définissez le champ sur le nom d’utilisateur de l’utilisateur actuel.

public void FormEvents_Loading(object sender, LoadingEventArgs e)
{
   // Create XPathNavigator positioned at the root of the main data 
   // source.
   XPathNavigator myNav = this.MainDataSource.CreateNavigator()

   // Select employee field and set value to username.
   myNav.SelectSingleNode("//my:employee",this.NamespaceManager).
      SetValue(System.Environment.UserName);
}

Public Sub FormEvents_Loading(ByVal sender As Object, ByVal e As LoadingEventArgs)
   ' Create XPathNavigator positioned at the root of the main data 
   ' source.
   Dim myNav As XPathNavigator = Me.MainDataSource.CreateNavigator()

   ' Select employee field and set value to username.
   myNav.SelectSingleNode("//my:employee", Me.NamespaceManager). _
      SetValue(System.Environment.UserName)
End Sub

Remarque : Il n’est pas nécessaire de référencer explicitement les mots clés this ou Me pour accéder aux membres de la classe dans le XmlForm code de formulaire. Par exemple, les lignes de code permettant d’accéder à la MainDataSource propriété dans les exemples C# et Visual Basic précédents peuvent être écrites comme suit :

XPathNavigator myNav = MainDataSource.CreateNavigator()
Dim myNav As XPathNavigator = MainDataSource.CreateNavigator()

Toutefois, l’utilisation des mots clés this ou Me lors de l’écriture de code facilite la saisie semi-automatique des instructions IntelliSense, qui répertorie les membres de la classe lors de l’écriture XmlForm de code de logique métier dans le module FormCode d’un modèle de formulaire.

Lorsque vous utilisez du code managé, les données XML sources d’un formulaire sont accessibles via la MainDataSource propriété qui retourne une instance de la DataSource classe qui représente la source de données main du formulaire. La CreateNavigator() méthode de la DataSource classe est ensuite utilisée pour créer un instance du System.Xml. Classe XPath.XPathNavigator qui est positionnée à la racine du document XML sous-jacent du formulaire. Vous pouvez alors utiliser les membres de la classe XPathNavigator pour naviguer, lire et écrire les données du formulaire. Pour plus d’informations sur l’utilisation de la classe XPathNavigator dans le code de formulaire InfoPath, consultez How to : Work with System.Xml from Managed-code Form Templates.

La XmlForm classe fournit également des propriétés supplémentaires qui peuvent être utilisées pour obtenir des informations sur le formulaire et son document XML sous-jacent. Elle propose aussi des méthodes qui permettent d’effectuer diverses actions liées au formulaire, par exemple, l’impression, l’enregistrement et l’envoi. Les événements au niveau du formulaire, tels que le chargement d’un formulaire, le changement d’affichage ou une opération de fusion, sont implémentés par la FormEvents classe . En outre, les événements déclenchés par les modifications apportées au document XML sous-jacent lui-même sont implémentés par la XmlEvents classe .

L’objet XmlForm est accessible à partir des XmlFormCollection classes et Window dans le modèle objet InfoPath. Le tableau suivant répertorie ces emplacements où l’objet XmlForm est disponible.

XmlFormCollection	Accessible à partir de l’objet Application à l’aide de la XmlForms propriété . Fournit la propriété et Microsoft.Office.InfoPath.XmlFormCollection.Open la Item[Int32] méthode permettant d’accéder aux XmlForm objets qu’elle contient.
Window	Fournit la XmlForm propriété permettant d’accéder à l’objet XmlForm associé à la fenêtre.

Dans le modèle objet de code managé compatible InfoPath 2003 (les types et les membres de l’espace Microsoft.Office.Interop.InfoPath.SemiTrust de noms), qui a été introduit pour la première fois dans InfoPath 2003 Service Pack 1 conjointement avec microsoft Office InfoPath 2003 Toolkit pour Visual Studio .NET, les classes suivantes fournissaient une propriété XDocument pour accéder au document XML sous-jacent d’un formulaire pendant les événements : DataDOMEventObjectClasses , DocEventObjectDocActionEventObject, , DocReturnEventObjectet VersionUpgradeEventObject .

Dans le nouveau modèle objet de code managé InfoPath (les types et les membres de l’espace Microsoft.Office.InfoPath de noms), vous utilisez les mots clés this (en C#) ou Me (en Visual Basic) pour accéder à la XmlForm classe et à ses membres à partir de gestionnaires d’événements et d’autres codes dans votre logique métier de modèle de formulaire.

Constructeurs

XmlForm()

Représente le document XML sous-jacent d'un formulaire.

Propriétés

CurrentView	Obtient un View objet qui représente la vue actuelle du formulaire.
DataConnections	Obtient un DataConnectionCollection objet associé au formulaire.
DataSources	Obtient l’objet DataSourceCollection associé au formulaire.
Dirty	Obtient une valeur qui indique si les données d’un formulaire ont été modifiées depuis son dernier enregistrement.
Environment	Obtient un Environment objet qui fournit des informations sur l’environnement d’exécution (l’éditeur InfoPath, le navigateur web ou le navigateur mobile) dans lequel le formulaire s’exécute.
Errors	Obtient une référence au FormErrorCollection associé à un formulaire.
Extension	Obtient un Object pour accéder aux fonctions et variables globales contenues dans le fichier de code de formulaire principal d’un formulaire à l’aide de System.Reflection.
FormState	Obtient une référence à un conteneur de propriétés de type System.Collections.IDictionary que les formulaires avec navigation activée peuvent utiliser pour conserver les informations d’état entre les sessions sur le serveur.
Host	Obtient un objet System.Object que du code s’exécutant dans une instance hébergée d’InfoPath peut utiliser pour accéder au modèle objet de l’application hôte.
Hosted	Obtient l’information indiquant qu’InfoPath est hébergé sous forme de contrôle dans une autre application.
HostName	Obtient le nom de l’application qui héberge InfoPath sous forme de contrôle.
MainDataSource	Obtient un DataSource objet qui représente la source de données main du formulaire.
NamespaceManager	Obtient une référence à un XmlNamespaceManager objet qui peut être utilisé pour résoudre, ajouter ou supprimer des espaces de noms utilisés dans le formulaire.
NetworkState	Obtient un NetworkState objet qui fournit des informations sur l’état de connexion de l’ordinateur client ou sur la possibilité d’une connexion à la destination réseau spécifiée.
New	Obtient une valeur qui spécifie s’il s’agit d’un nouveau formulaire.
Permission	Obtient une référence à un Permission objet associé au formulaire.
QueryDataConnection	Obtient une référence à l’objet DataConnection qui représente la connexion de données associée au formulaire.
ReadOnly	Obtient une valeur qui indique si un modèle de formulaire est en lecture seule ou s’il est verrouillé.
Recovered	Obtient une valeur qui indique si un formulaire a été enregistré pour la dernière fois par une opération de récupération automatique.
ServerInfo	Obtient un ServerInfo objet qui fournit des informations sur le serveur SharePoint où se trouve le formulaire.
Signed	Obtient une valeur qui indique si un formulaire a été signé numériquement à l’aide de signatures numériques.
SignedDataBlocks	Obtient une référence à la SignedDataBlockCollection collection associée à un formulaire.
TaskPanes	Obtient une référence au TaskPaneCollection associé à un modèle de formulaire.
Template	Obtient une référence à l’objet FormTemplate qui représente le manifeste (.xsf) du modèle de formulaire associé au formulaire.
Uri	Obtient l’URI (Uniform Resource Identifier) d’un formulaire.
User	Obtient un User objet qui fournit des informations sur l’utilisateur actuel du formulaire.
UserRole	Obtient ou définit l’utilisateur actuel du nom de rôle du formulaire.
ViewInfos	Obtient une référence à l’objet ViewInfoCollection associé au modèle de formulaire.
XmlLang	Obtient la valeur de l’attribut xml:lang dans le document XML sous-jacent du formulaire.

Méthodes

Close()	Ferme le formulaire.
GetWorkflowTasks()	Obtient une référence à une collection Microsoft.Office.Core.WorkflowTasks pour le formulaire actif.
GetWorkflowTemplates()	Obtient une référence à une collection Microsoft.Office.Core.WorkflowTemplates pour le formulaire actif.
MergeForm(String)	Fusionne le formulaire actif avec le formulaire spécifié par un chemin d’accès ou une URL.
MergeForm(XPathNavigator)	Fusionne le formulaire actif avec le formulaire cible spécifié dans le nœud retourné par le XPathNavigator passé à la méthode .
NotifyHost(String)	Fournit une valeur personnalisée à l’application hôte ou à la page ASPX.
Print()	Imprime le contenu d’un formulaire tel qu’il s’affiche dans la vue active du formulaire.
Print(Boolean)	Imprime le contenu d’un formulaire tel qu’il s’affiche dans la vue active du formulaire en affichant la boîte de dialogue Imprimer.
Save()	Enregistre le formulaire dans l’URL (Uniform Resource Locator) qui lui est actuellement associée.
SaveAs(String)	Enregistre le formulaire dans l’URL (Uniform Resource Locator) spécifiée.
SetSaveAsDialogFilename(String)	Définit le nom de fichier par défaut dans la boîte de dialogue Enregistrer sous.
SetSaveAsDialogLocation(String)	Définit le chemin d’accès par défaut pour enregistrer le formulaire dans la boîte de dialogue Enregistrer sous.
Submit()	Envoie le formulaire à l’aide de l’opération d’envoi définie dans le modèle de formulaire.