(XPathNavigator, String, String) del método FormErrorCollection.Add

Artículo
05/12/2015

Crea un objeto FormError y lo agrega al objeto FormErrorCollection asociado al formulario actual.

Espacio de nombres: Microsoft.Office.InfoPath
Ensamblado: Microsoft.Office.InfoPath (en Microsoft.Office.InfoPath.dll)

Sintaxis

'Declaración
Public MustOverride Function Add ( _
    context As XPathNavigator, _
    name As String, _
    message As String _
) As FormError
'Uso
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
)

Parámetros

context
Tipo: System.Xml.XPath.XPathNavigator

Objeto XPathNavigator situado en el nodo al que se va a asociar el error

name
Tipo: System.String

Nombre del error (no puede estar en blanco).

message
Tipo: System.String

Mensaje breve del error.

Valor devuelto

Tipo: Microsoft.Office.InfoPath.FormError
Se ha agregado a la colección una referencia al nuevo objeto FormError.

Excepciones

Excepción	Condición
ArgumentNullException	Los parámetros pasados a este método son una referencia null (Nothing en Visual Basic).
ArgumentException	Los parámetros que se han pasado a este método no son válidos. Por ejemplo, son de un tipo o formato no válido.

Comentarios

La propiedad FormErrorType del nuevo objeto FormError se establecerá en UserDefined.

Nota

Se pueden agregar varios errores con el mismo nombre valor del parámetro name a diferentes nodos de context. Sin embargo, si se agrega un error con el mismo nombre al mismo nodo de context dos veces, el error agregado en segundo lugar anula al primero.

Únicamente se puede acceder a este miembro con formularios que se ejecuten en el mismo dominio que el formulario que está actualmente abierto o con formularios a los que se hayan concedido permisos entre dominios.

Se puede acceder a este tipo o miembro desde el código que se ejecuta en los formularios abiertos en Microsoft InfoPath Filler o en un explorador web.

Ejemplos

En el ejemplo siguiente, primero se pone un objeto XPathNavigator en el campo al que se va a asociar un error. A continuación, el objeto XPathNavigator, el nombre y el mensaje se pasan al método Add de la clase FormErrorCollection para agregar el error a la colección de errores del formulario.

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.")