SaveEventObject Interface

Definition

Namespace:

Microsoft.Office.Interop.InfoPath

Assembly:

Microsoft.Office.Interop.InfoPath.dll

An event that is used during OnSaveRequest.

public interface class SaveEventObject : Microsoft::Office::Interop::InfoPath::SaveEvent

[System.Runtime.InteropServices.Guid("096CD5F5-0786-11D1-95FA-0080C78EE3BB")]
public interface SaveEventObject : Microsoft.Office.Interop.InfoPath.SaveEvent

type SaveEventObject = interface
    interface SaveEvent

Public Interface SaveEventObject
Implements SaveEvent

Derived

Microsoft.Office.Interop.InfoPath.SaveEventObjectClass

Attributes

GuidAttribute

Implements

SaveEvent

Examples

In the following example, the ReturnStatus property and the PerformSaveOperation() method of the SaveEvent object are used to perform a standard Microsoft InfoPath save operation:

public void OnSaveRequest(<span class="label">SaveEvent</span> e)
{
 e.PerformSaveOperation();
 e.ReturnStatus = true;
}

Remarks

This type is a wrapper for a coclass that is required by managed code for COM interoperability. Use this type to access the members of the COM interface implemented by this coclass. For information about the COM interface, including a link to descriptions of its members, seeSaveEvent.

The SaveEventObject object provides a number of properties and methods that can be used during a save operation from the OnSaveRequest event handler to programmatically interact with a form's underlying XML document, determine save properties, and perform the save operation.

The SaveEventObject object is passed as a parameter to the OnSaveRequest event. The properties that it provides are available only during this event. This object expires when the form's save event expires so it may not be stored and used outside of the scope of the save event.

Properties

FileName	Gets the file name to be used in the OnSaveRequest event. (Inherited from SaveEvent)
IsCancelled	Gets or sets a value that provides additional information for use in OnSaveRequest event in conjunction with the ReturnStatus property. (Inherited from SaveEvent)
IsSaveAs	Gets whether the PerformSaveOperation() method will be performed as a "save" operation or as a "save as" operation. (Inherited from SaveEvent)
ReturnStatus	Gets or sets the return status of the OnSaveRequest event. (Inherited from SaveEvent)
XDocument	Gets a reference to the XDocument object that is associated with the SaveEventObject object in an OnSaveRequest event. (Inherited from SaveEvent)

Methods

PerformSaveOperation()

Performs the save operation requested by the user. (Inherited from SaveEvent)