DataDOMEvent.ReportError Method

Definition

Namespace:

Microsoft.Office.Interop.InfoPath

Assembly:

Microsoft.Office.Interop.InfoPath.dll

Creates an ErrorObject object and adds it to the ErrorsCollection collection.

public Microsoft.Office.Interop.InfoPath.ErrorObject ReportError (object varNode, string bstrShortErrorMessage, bool fSiteIndependent, string bstrDetailedErrorMessage = "", int lErrorCode = 0, string bstrType = "modeless");

abstract member ReportError : obj * string * bool * string * int * string -> Microsoft.Office.Interop.InfoPath.ErrorObject

Public Function ReportError (varNode As Object, bstrShortErrorMessage As String, fSiteIndependent As Boolean, Optional bstrDetailedErrorMessage As String = "", Optional lErrorCode As Integer = 0, Optional bstrType As String = "modeless") As ErrorObject

Parameters

varNode

Object

The XML Document Object Model (DOM) node that the error is associated with.

bstrShortErrorMessage

String

The text to be used for the short error message.

fSiteIndependent

Boolean

Sets the condition for automatic deletion of the Error object. If true, the Error object will be deleted on change for any nodes that matched the XPath expression corresponding to the Error object. If false, the Error object will be deleted when the node returned by the Site property of a given event object has been changed.

bstrDetailedErrorMessage

String

The text to be used for the detailed error message.

lErrorCode

Int32

The number to be used as the error code.

bstrType

String

Default value is "modeless". Determines whether the change in value will be automatically rejected or whether the user will be prompted to accept or reject the change. The other value is "modal".

Returns

ErrorObject

The ErrorObject object representing the newly created Error.

Examples

In the following example, the Site property of the DataDOMEventObject object is used to check the value of the node. If the data validation fails, the ReportError method is used to create a custom error.

public void field1_OnValidate(DataDOMEvent e)
{
 if (int.Parse(e.Site.text) > 50)
 {
  e.<span class="label">ReportError</span>(
   e.Site, 
   "Invalid quantity. The total number of each type of block cannot exceed 50.", 
   false,
   "",
   2,
   "modeless");
 }

 if (int.Parse(e.Site.text) &lt; 0)
 {
  e.ReportError(
   e.Site, 
   "Invalid quantity. The total number of each type of block cannot be less than 0.", 
   false,
   "",
   2,
   "modeless");
 }
}

Remarks

When the ReportError method is called, Microsoft Office InfoPath 2003 creates an Error object and adds it to the Errors collection. Errors are removed from the collection when the validation constraint is no longer invalid. In certain cases they can be explicitly removed using the Delete(Object, String) or DeleteAll() methods.

Errors can also be created using the Add(Object, String, String, String, Int32, String) method.

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

Note: The ReportError method can only be used during the OnValidate event.