Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

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

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)
public abstract void ReportError(
	XPathNavigator node,
	bool siteIndependent,
	string message,
	string messageDetails,
	int errorCode,
	ErrorMode errorMode
)

Parameters

node
Type: System.Xml.XPath.XPathNavigator

An XPathNavigator positioned at the node that contains the data the error is associated with.

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.

errorMode
Type: Microsoft.Office.InfoPath.ErrorMode

An ErrorMode that specifies whether the error will be displayed in a modal dialog box, or modelessly with a wavy underline in the affected control.

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

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.

NoteNote

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 only from code running in forms opened in Microsoft InfoPath Filler.

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,
            ErrorMode.Modeless);
      }

      if (fieldValue < 0)
      {
         e.ReportError(e.Site,
            false,
            "Invalid quantity",
            "The total number cannot be less than 0.",
            12346,
            ErrorMode.Modeless);
      }
   }
}
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

Show:
© 2014 Microsoft. All rights reserved.