File: xdevtOnSubmitRequest.htm

package info (click to toggle)
office2003-schemas 1.0%2Bds-1
  • links: PTS, VCS
  • area: non-free
  • in suites: bookworm, forky, sid, trixie
  • size: 42,304 kB
  • sloc: javascript: 2,429; makefile: 29
file content (57 lines) | stat: -rw-r--r-- 4,687 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
<html dir="ltr"><head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<META HTTP-EQUIV="assetid" CONTENT="HV01021370"><META NAME="lcid" CONTENT="1033"><title>OnSubmitRequest Event</title><link rel="stylesheet" type="text/css" href="office10.css"><script type="text/javascript" language="Javascript" src="ExpCollapse.js"></script><script type="text/javascript" language="JavaScript" src="inline.js"></script></head><body><p id="ExpandAllLine" class="ExpFav"><a href="#" onclick="ExpandAll()" onkeypress="ExpandAll()" class="DropDown"><img id="picHeader" border="0" src="expandtri.gif" alt="Show All"><span id="ExpandAll">Show All</span></a></p><h1>OnSubmitRequest Event</h1><DIV class="ofvbanav"><span class="ofvbanavreuse" id="seealso" onclick="toggleList()" onkeypress="toggleList()"></span><span class="ofvbanavreuse" id="appliesto" onclick="toggleList()" onkeypress="toggleList()"></span><a class="ofvbanavex" href="#example"><span class="ofvbanavreuse" id="example"></span></a><span class="ofvbanavreuse" id="specifics" onclick="toggleList()" onkeypress="toggleList()"></span></DIV><p>
      <p>Occurs when the submit operation is invoked either from the Microsoft Office InfoPath 2003 user interface or by using the <b class="bterm"><a href="xdmthSubmit.htm" id="HV01021418" lcid=" ">Submit</a></b> method of the <b class="bterm"><a href="xdobjXDocument.htm" id="HV01021254" lcid=" ">XDocument</a></b> object in the InfoPath object model.</p>
      
        <p class="signature">Function <i>XDocument</i>::<b class="bterm">OnSubmitRequest</b>(ByRef <b class="bterm"><i>pEvent</i></b> As DocReturnEvent)</p>
        <p>
          <b class="bterm">
            <i>pEvent</i>
          </b>Required <b class="bterm">DocReturnEvent</b>. A reference to the <b class="bterm"><a href="xdobjDocReturnEvent.htm" id="HV01021242" lcid=" ">DocReturnEvent</a></b> object.</p>
      
    </p><h2>Remarks</h2><p>
      <p>This <a href="#" class="glossary" onclick="AppendPopup(this,'xdeventhandler')" onkeypress="AppendPopup(this,'xdeventhandler')">event handler</a> allows users to cancel an operation.</p><p>If the <b class="bterm"><a href="xdproReturnStatus_3.htm" id="HV01021329" lcid=" ">ReturnStatus</a></b> property of the <b class="bterm">DocReturnEvent</b> object is set to False, InfoPath cancels the submit operation. If an error occurs in the scripting code for the OnSubmitRequest event handler, InfoPath ignores it and relies on the <b class="bterm">ReturnStatus</b> property of the <b class="bterm">DocReturnEvent</b> object. If the <b class="bterm">ReturnStatus</b> property is not explicitly set, the default value of False is used.</p>
    </p><h2><a id="#example" name="#example">Example</a></h2><p>
      <p>In the following example, the OnSubmitRequest event handler is used to create an <b class="bterm">XMLHTTP</b> object for transporting the form's underlying XML document:</p>
      <pre><code>function XDocument::<b class="bterm">OnSubmitRequest</b>(eventObj)
{
   // Create an XMLHTTP object for document transport.
   try
   {
      var objXmlHttp = new ActiveXObject("MSXML2.XMLHTTP.5.0");
   }
   catch(ex)
   {
      XDocument.UI.Alert("Could not create MSXML2.XMLHTTP 
         object.\r\n" + ex.number + " - " + ex.description);

      // Return is equivalent to setting eventObj.ReturnStatus = false, 
      // because no change was made to this value.
      return;	
   }

   // Post the XML document to strUrl.
   objXmlHttp.open("POST", strUrl, false);
   try
   {
      objXmlHttp.send(XDocument.DOM.xml);
   }
   catch(ex)
   {
      XDocument.UI.Alert("Could not post (ASP) document to " + 
         strUrl + "\r\n" + ex.number + " - " + ex.description);

      // Return is equivalent to setting eventObj.ReturnStatus = false.
      return;
   }
   // If here, the submit operation is has been successful.
   eventObj.ReturnStatus = true;	
}
</code></pre>
    </p><script type="text/javascript" language="JScript" src="ofvbanl.js"></script><span id="ofVBAISpan" class="ofvbaispan"><iframe id="ofVBAIFrame" frameborder="0" marginheight="0" marginwidth="4" scrolling="auto" width="100%" src="../links/xdevtOnSubmitRequest_l.htm"></iframe></span><center><a href="XMLSchemaCopyright_HV01147162.htm">&copy;2003-2004 Microsoft Corporation. All rights reserved.</a>  

Permission to copy, display and distribute this document is available at: <a 

href="http://r.office.microsoft.com/r/rlidAWSContentRedir?AssetID=XT010988631033&amp;CTT=11&amp;Origin=HV011232471033" 

target="_new">http://msdn.microsoft.com/library/en-us/odcXMLRef/html/odcXMLRefLegalNotice.asp</a></center></body></html>