XmlValidatingEventArgs.ReportError method (XPathNavigator, Boolean, String, String, Int32)

  • Article

Creates a FormError object that contains custom error information with the specified values and adds it to the FormErrorCollection object of the form.

Namespace:  Microsoft.Office.InfoPath
Assembly:  Microsoft.Office.InfoPath (in Microsoft.Office.InfoPath.dll)

Syntax

'Declaration
Public MustOverride Sub ReportError ( _
    node As XPathNavigator, _
    siteIndependent As Boolean, _
    message As String, _
    messageDetails As String, _
    errorCode As Integer _
)
'Usage
Dim instance As XmlValidatingEventArgs
Dim node As XPathNavigator
Dim siteIndependent As Boolean
Dim message As String
Dim messageDetails As String
Dim errorCode As Integer

instance.ReportError(node, siteIndependent, _
    message, messageDetails, errorCode)

public abstract void ReportError(
    XPathNavigator node,
    bool siteIndependent,
    string message,
    string messageDetails,
    int errorCode
)

Parameters

  • siteIndependent
    Type: System.Boolean

    Sets the condition for automatic deletion of the FormError object. If set to true, the FormError object will be deleted for changes to any nodes that match the XPath expression returned by the Match property of this event object. If set to false, the FormError object is deleted the next time the form is validated only when the node returned by the Site property of this event object has been changed.

  • message
    Type: System.String

    The text to be used for the short error message.

  • messageDetails
    Type: System.String

    The text to be used for the detailed error message.

  • errorCode
    Type: System.Int32

    The number to be used as the error code.

Exceptions

Exception Condition
ArgumentException

The parameters passed to this method are not valid.
ArgumentNullException

The parameters passed to this method are a null reference (Nothing in Visual Basic).

Remarks

The ReportError method is used to create a custom error for an error that occurred during the Validating event.

When the ReportError method is called, InfoPath creates a FormError object and adds it to the FormErrorCollection of the current form. FormError objects are removed from the collection when the validation constraint is no longer invalid. In certain cases they can be explicitly removed using the Delete or DeleteAll methods.

FormError objects can also be created using the Add method of the FormErrorCollection class.

Note

Site-independent errors should be used when you want the errors to apply to all nodes of the same type. If you want the error to apply to a specific node, use site-dependent errors.

This member can be accessed only by forms running in the same domain as the currently open form, or by forms that have been granted cross-domain permissions.

This type or member can be accessed from code running in forms opened in Microsoft InfoPath Filler or in a Web browser.

Examples

In the following example, the Site property that the XmlValidatingEventArgs class inherits from the XmlEventArgs class is used to check the value of the node that raised the Validating event. If the data validation fails, the ReportError method is used to create a custom error.

public void field1_Validating(object sender, XmlValidatingEventArgs e)
{
   if (e.Site.InnerXml != String.Empty)
   {
      int fieldValue = int.Parse((e.Site.InnerXml));

      if (fieldValue > 50)
      {
         e.ReportError(e.Site,
            false,
            "Invalid quantity",
            "The total number cannot exceed 50.",
            12345);

      }

      if (fieldValue < 0)
      {
         e.ReportError(e.Site,
            false,
            "Invalid quantity",
            "The total number cannot be less than 0.",
            12346);
      }
   }
}

Public Sub field1_Validating(ByVal sender As Object , _
   ByVal e As XmlValidatingEventArgs)
   If (e.Site.InnerXml <> String.Empty) Then
      Integer fieldValue = Integer.Parse((e.Site.InnerXml))

      If (fieldValue > 50) Then
         e.ReportError(e.Site,
            false,
            "Invalid quantity",
            "The total number cannot exceed 50.",
            12345)
      End If

      If (fieldValue < 0) Then
         e.ReportError(e.Site,
            false,
            "Invalid quantity",
            "The total number cannot be less than 0.",
            12346)
      End If
   End If
End Sub

See also

Reference

XmlValidatingEventArgs class

XmlValidatingEventArgs members

ReportError overload

Microsoft.Office.InfoPath namespace