File: xdobjSaveEventObject_HV01104135.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 (15 lines) | stat: -rw-r--r-- 3,655 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
<html dir="ltr"><head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<META HTTP-EQUIV="assetid" CONTENT="HV01104135"><META NAME="lcid" CONTENT="1033"><title>SaveEvent Object</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><h1>SaveEvent Object</h1><div class="ofvbanav"><span class="ofvbanavreuse" id="seealso" onclick="toggleList()" onkeypress="toggleList()"></span><span class="ofvbanavreuse" id="properties" onclick="toggleList()" onkeypress="toggleList()"></span><span class="ofvbanavreuse" id="methods" onclick="toggleList()" onkeypress="toggleList()"></span><span class="ofvbanavreuse" id="events" onclick="toggleList()" onkeypress="toggleList()"></span><span class="ofvbanavreuse" id="specifics" onclick="toggleList()" onkeypress="toggleList()"></span></div><p>An event object that is used during an <a href="xdevtOnSaveRequest_HV01104133.htm" id="HV01104133" lcid=" "><b class="bterm">OnSaveRequest</b></a> event.  The <b class="bterm">SaveEvent</b> object provides a number of properties and methods that can be used during a save operation from the <b class="bterm">OnSaveRequest</b> event handler to programmatically interact with a form's underlying XML document, determine save properties, and perform the save operation.  </p><h2>Remarks</h2><p><p><b>Note</b>  This object model member is not supported when the <b class="ui">Disable Service Pack features</b> option on the <b class="ui">Advanced</b> tab of the <b class="ui">Options</b> dialog box in InfoPath is selected or when Microsoft Office 2003 Service Pack 1 or later is not installed. Any form that implements this object model member in its code will generate an error message if it is opened in InfoPath when service pack features are disabled or unavailable.</p></p><h2>Using the SaveEvents object</h2><p>The <b class="bterm">SaveEvent</b> object is passed as a parameter to the<b class="bterm">OnSaveRequest</b> event of an InfoPath form.  The properties that it provides are available only during this event.

This object expires when the save event expires so it may not be stored and used outside of the scope of the save event.</p><h2><a id="#example" name="#example">Example</a></h2><p>In the following example, the <a href="xdproReturnStatus_6_HV01104790.htm" id="HV01104790" lcid=" "><b class="bterm">ReturnStatus</b></a> property and the <a href="xdmthPerformSaveOperation_HV01103985.htm" id="HV01103985" lcid=" "><b class="bterm">PerformSaveOperation</b></a> method of the <b class="bterm">SaveEvent</b> object are used to perform a standard InfoPath save operation:</p><pre><code>function XDocument::OnSaveRequest(eventObj) 
{
    eventObj.PerformSaveOperation();
    eventObj.ReturnStatus = true;
}</code></pre><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/xdobjSaveEventObject_HV01104135_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>