FormErrorCollection.Add - Méthode (XPathNavigator, String, String)

Article
05/11/2015

Crée une nouvelle FormError et l'ajoute à la collectionFormErrorCollection associée au formulaire actif.

Espace de noms : Microsoft.Office.InfoPath
Assembly : Microsoft.Office.InfoPath (dans Microsoft.Office.InfoPath.dll)

Syntaxe

'Déclaration
Public MustOverride Function Add ( _
    context As XPathNavigator, _
    name As String, _
    message As String _
) As FormError
'Utilisation
Dim instance As FormErrorCollection
Dim context As XPathNavigator
Dim name As String
Dim message As String
Dim returnValue As FormError

returnValue = instance.Add(context, name, _
    message)

public abstract FormError Add(
    XPathNavigator context,
    string name,
    string message
)

Paramètres

context
Type : System.Xml.XPath.XPathNavigator

Objet XPathNavigator placé sur le nœud auquel sera associée l'erreur.

name
Type : System.String

Nom de l'erreur (ne peut pas rester vide).

message
Type : System.String

Message court de l'erreur.

Valeur renvoyée

Type : Microsoft.Office.InfoPath.FormError
Référence à la nouvelle FormError ajoutée à la collection.

Exceptions

Exception	Condition
ArgumentNullException	Les paramètres transmis à cette méthode sont une référence Null (Rien dans Visual Basic).
ArgumentException	Les paramètres transmis à cette méthode ne sont pas valides. Par exemple, ils sont d'un type ou format incorrect.

Remarques

Le FormErrorType de la nouvelle FormError aura la valeur UserDefined.

Notes

Il est possible d'ajouter plusieurs erreurs avec la même valeur de paramètre name à plusieurs nœuds de context. Toutefois, si vous ajoutez deux fois une erreur portant le même nom au même nœud context, la deuxième erreur ajoutée remplace la première.

Seuls les formulaires qui s’exécutent dans le même domaine que le formulaire actuellement ouvert ou les formulaires disposant d’autorisations inter-domaines peuvent accéder à ce membre.

Vous pouvez accéder à ce type ou à ce membre à partir du code exécuté dans les formulaires ouverts dans Microsoft InfoPath Filler ou dans un navigateur web.

Exemples

Dans l'exemple suivant, un objet XPathNavigator est d'abord placé sur le champ auquel associer une erreur. Ensuite, le XPathNavigator, le nom et le message sont transmis à la méthode Add de la classe FormErrorCollection pour ajouter l'erreur à la collection d'erreurs du formulaire.

XPathNavigator root, txtbox;
// Create XPathNavigator for main data source.
root = this.MainDataSource.CreateNavigator();

// Create XPathNavigator positioned at field to associate with error.
txtbox = root.SelectSingleNode("//my:field1", this.NamespaceManager);

// Get form's collection of errors and add error.
this.Errors.Add(txtbox, "Field1Error", "Short error message.");

Dim root, txtbox As XPathNavigator
' Create XPathNavigator for main data source.
root = Me.MainDataSource.CreateNavigator()

' Create XPathNavigator positioned at field to add error.
txtbox = root.SelectSingleNode("//my:field1", Me.NamespaceManager)

' Get form's collection of errors and add error.
Me.Errors.Add(txtbox, "Field1Error", "Short error message.")