DocReturnEventObject-Schnittstelle

  • Artikel

Ein Ereignisobjekt, das während eines Lade- oder Sendeereignisses in Microsoft Office InfoPath 2007 verwendet wird.

Namespace: Microsoft.Office.Interop.InfoPath
Assembly: Microsoft.Office.Interop.InfoPath (in microsoft.office.interop.infopath.dll)

Syntax

<CoClassAttribute(GetType(DocReturnEventObjectClass))> _
<GuidAttribute("096CD676-0786-11D1-95FA-0080C78EE3BB")> _
Public Interface DocReturnEventObject
    Inherits DocReturnEvent

Dim instance As DocReturnEventObject

[CoClassAttribute(typeof(DocReturnEventObjectClass))] 
[GuidAttribute("096CD676-0786-11D1-95FA-0080C78EE3BB")] 
public interface DocReturnEventObject : DocReturnEvent

Hinweise

Dies ist ein Wrappertyp für eine Coklasse, die für den verwalteten Code der COM-Interoperabilität erforderlich ist. Verwenden Sie diesen Typ zum Zugreifen auf die Member der COM-Schnittstelle, die von der Coklasse implementiert wurden. Informationen zur COM-Schnittstelle, einschließlich eines Links zu den Memberbeschreibungen, finden Sie unter DocReturnEvent.

Das DocReturnEvent-Objekt stellt die XDocument-Eigenschaft bereit, die in einem Lade- oder Sendeereignis verwendet werden kann, um mit den Daten im zugrunde liegenden XML-Dokument eines Formulars programmgesteuert zu interagieren. Es stellt auch die ReturnStatus-Eigenschaft bereit, die verwendet wird, um anzugeben, ob das Ereignis erfolgreich ist.

Das DocReturnEvent-Objekt wird als Parameter an die Ereignisse OnLoad und OnSubmitRequest eines InfoPath-Formulars übergeben. Die vom Objekt bereitgestellten Eigenschaften sind nur während dieser Ereignisse verfügbar.

Beispiel

Im folgenden Beispiel wird die XDocument-Eigenschaft des DocReturnEvent-Objekts verwendet, um die Quell-XML-Daten des einem Formular zugrunde liegenden XML-Dokuments mithilfe der DOM-Eigenschaft des XDocument-Objekts anzuzeigen:

public void OnLoad(DocReturnEvent e)
{
 thisXDocument.UI.Alert("The source XML: " + e.XDocument.DOM.xml);
 e.ReturnStatus = true;
}

Siehe auch

Referenz

DocReturnEventObject-Member
Microsoft.Office.Interop.InfoPath-Namespace