DocReturnEvent.ReturnStatus Property

  • Article
InfoPath Developer Reference

Sets or retrieves a Boolean value indicating the return status of the OnLoad and OnSubmitRequest events. Read/write

Version Information
 Version Added:  InfoPath 2003

Syntax

expression.ReturnStatus

expression   An expression that returns a DocReturnEvent object.

Return Value
Boolean

Remarks

If the ReturnStatus property is set to False, the onload and OnSubmitRequest events fail. If set to True, the onload and OnSubmitRequest events are successful. The default value for the OnLoad event is True, and the default value for the OnSubmitRequest event is False.

Security Level 2: 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.

Example

In the following example, the ReturnStatus property of the DocReturnEvent object is used to indicate that the OnLoad event was not successful:

JScript 
  function XDocument::OnLoad(eventObj)
{
   // Cancel the event.
   eventObj.ReturnStatus = false;
}

See Also