Freigeben über


XDocument Schnittstelle

Definition

Stellt das zugrunde liegende XML-Dokument eines Formulars dar.

public interface class XDocument : Microsoft::Office::Interop::InfoPath::SemiTrust::_XDocument2
[System.Runtime.InteropServices.Guid("096cd6a8-0786-11d1-95fa-0080c78ee3bb")]
public interface XDocument : Microsoft.Office.Interop.InfoPath.SemiTrust._XDocument2
type XDocument = interface
    interface _XDocument2
    interface _XDocument
Public Interface XDocument
Implements _XDocument2
Attribute
Implementiert

Beispiele

Die XML-Quelldaten eines Formulars haben die Form eines XML-DOM (Document Object Model), auf das über die DOM -Eigenschaft des XDocument-Objekts zugegriffen wird. Das XDocument-Objekt stellt darüber hinaus mehrere Eigenschaften bereit, mit deren Hilfe Informationen zum Formular und dem zugrunde liegenden XML-Dokument abgerufen werden können. Der folgende Code überprüft beispielsweise mithilfe der -Eigenschaft, ob Daten im Formular geändert IsDirty wurden:

if (thisXDocument.IsDirty)
{
   thisXDocument.UI.Alert("Form has been changed.");
}
else
{
   thisXDocument.UI.Alert("Form has not been changed.");
}

Zusätzlich zu den Informationen zum Formular und zu dem ihm zugrunde liegenden XML-Dokument stellt das XDocument-Objekt mehrere Methoden bereit, die für Formularvorgänge verwendet werden können, z. B. zum Drucken, Speichern und Senden. Es stellt weiterhin mehrere Ereignisse bereit, die verwendet werden können, um auf verschiedene, auf Formularebene stattfindende Aktionen zu reagieren, z. B. das Laden eines Formulars, das Wechseln einer Ansicht oder ein Zusammenführungsvorgang.

Ein weiteres Beispiel, das die Arbeit mit dem XDocument-Objekt veranschaulicht, finden Sie unter

Vorgehensweise: Zugreifen auf Anwendungsdaten (InfoPath 2003-Objektmodell).

Hinweise

Dieser Typ ist ein Wrapper für eine CoClass, die von verwaltetem Code für COM-Interoperabilität benötigt wird. Verwenden Sie diesen Typ, um auf die Mitglieder der COM-Schnittstelle zuzugreifen, die von dieser CoClass implementiert wird. Informationen zur COM-Schnittstelle, einschließlich eines Links zu Beschreibungen ihrer Member, finden Sie unter_XDocument2 .

Mithilfe der Member der _XDocument2-Schnittstelle wird Kompatibilität mit InfoPath 2003 bereitgestellt. Um neue Member zu verwenden, die dem XDocument-Objektmodell in Microsoft InfoPath 2010 wie der Permission -Eigenschaft hinzugefügt wurden, müssen Sie das XDocument-Objekt in den _XDocument3 Typ umwandeln. Weitere Informationen hierzu finden Sie unter Vorgehensweise: Verwenden von Objektmodellmembern, die nicht mit InfoPath 2003 kompatibel sind.

Beim XDocument-Objekt handelt es sich um ein Schlüsselobjekt im InfoPath-Objektmodell. Es stellt Eigenschaften, Methoden und Ereignisse bereit, die verwendet werden können, um mit den XML-Quelldaten eines Formulars programmgesteuert zu interagieren und sie zu bearbeiten.

Während der Zugriff auf das XDocument-Objekt mithilfe der XDocumentsCollection Auflistung möglich ist, greifen Sie in den meisten Fällen über die thisXDocument-Variable darauf zu, die in der _Startup-Methode eines Projekts mit verwaltetem Code instanziiert wird, ohne die Auflistung zu durchlaufen.

Die XML-Quelldaten eines Formulars haben die Form eines XML-DOM (Document Object Model), auf das über die DOM -Eigenschaft zugegriffen wird. Das XDocument-Objekt stellt darüber hinaus mehrere Eigenschaften bereit, mit deren Hilfe Informationen zum Formular und dem zugrunde liegenden XML-Dokument abgerufen werden können. Es bietet zudem verschiedene Methoden, die auf das Formular angewendet werden können, wie z. B. zum Drucken, Speichern und Senden. Das XDocument-Objekt stellt weiterhin mehrere Ereignisse bereit, die verwendet werden können, um auf verschiedene, auf Formularebene stattfindende Aktionen zu reagieren, z. B. das Laden eines Formulars, das Wechseln einer Ansicht oder ein Zusammenführungsvorgang.

Zugreifen auf das XDocument-Objekt

Der Zugriff auf das XDocument-Objekt innerhalb des InfoPath-Objektmodells kann auf unterschiedliche Weise erfolgen. Die folgende Tabelle enthält eine Zusammenfassung der Optionen, die den Zugriff auf das XDocument-Objekt ermöglichen.

XDocumentsCollection Zugriff über Application. Ermöglicht Item[Object] den Zugriff auf die darin enthaltenen XDocument-Objekte .
DataDOMEventObject Ermöglicht XDocument den Zugriff auf die XML-Quelldaten während einer XML-DOM-Änderung.
DocActionEventObject Ermöglicht XDocument den Zugriff auf die XML-Quelldaten während eines Schaltflächenklicks im Formularbereich.
DocEventObject Ermöglicht XDocument den Zugriff auf die XML-Quelldaten während einer Switchansicht oder eines Formularzusammenführungsvorgangs.
DocReturnEventObject Ermöglicht XDocument den Zugriff auf das Quell-XML während des Ladens oder Übermittelns eines Formulars.
VersionUpgradeEventObject Stellt XDocument den Zugriff auf das Quell-XML während des Versionsupgradevorgangs bereit.
WindowObject Ermöglicht XDocument den Zugriff auf das XDocument-Objekt , das dem Fenster zugeordnet ist.

Eigenschaften

DataAdapters

Ruft einen Verweis auf die DataAdaptersCollection Auflistung ab, die einem Formular zugeordnet ist.

(Geerbt von _XDocument2)
DataObjects

Ruft einen Verweis auf die DataObjectsCollection Auflistung ab, die einem Formular zugeordnet ist.

(Geerbt von _XDocument2)
DOM

Ruft einen Verweis auf das einem Formular zugrunde liegende XML-Dokument in Form von XML-DOM (Document Object Model) ab.

(Geerbt von _XDocument2)
Errors

Ruft einen Verweis auf die ab, die ErrorsCollection einem Formular zugeordnet ist.

(Geerbt von _XDocument2)
Extension

Ruft einen Verweis auf das globale Skriptobjekt ab, das die Funktionen und globalen Variablen verfügbar macht, die in der primären Formularcodedatei eines Formulars enthalten sind.

(Geerbt von _XDocument2)
IsDirty

Ruft einen Wert ab, der angibt, ob die Daten in einem Formular seit dem letzten Speichern geändert wurden.

(Geerbt von _XDocument2)
IsDOMReadOnly

Ruft einen Wert ab, der angibt, ob die Daten in dem zugrunde liegenden XML-Dokument eines Formulars in den Schreibschutzmodus versetzt wurden.

(Geerbt von _XDocument2)
IsNew

Ruft einen Wert ab, der angibt, ob ein neu erstelltes Formular gespeichert wurde.

(Geerbt von _XDocument2)
IsReadOnly

Ruft einen Wert ab, der angibt, ob sich ein Formular im Schreibschutzmodus befindet.

(Geerbt von _XDocument2)
IsRecovered

Ruft einen Wert ab, der angibt, ob ein Formular zuletzt mithilfe eines AutoWiederherstellen-Speichervorgangs gespeichert wurde.

(Geerbt von _XDocument2)
IsSigned

Ruft einen Wert ab, der angibt, ob ein Formular mithilfe digitaler Signaturen digital signiert wurde.

(Geerbt von _XDocument2)
Language

Ruft den Standardsprachcode eines Formulars ab, oder legt ihn fest.

(Geerbt von _XDocument2)
QueryAdapter

Ruft einen Verweis auf das Datenadapterobjekt ab, das einem Formular zugeordnet ist.

(Geerbt von _XDocument2)
Role

Ruft die aktuelle Rolle des Benutzers ab, oder legt sie fest.

(Geerbt von _XDocument2)
SignedDataBlocks

Ruft einen Verweis auf die Auflistung ab, die SignedDataBlocksCollection einem XDocument -Objekt zugeordnet ist.

(Geerbt von _XDocument2)
Solution

Ruft einen Verweis auf das SolutionObject -Objekt ab, das einem Formular zugeordnet ist.

(Geerbt von _XDocument2)
UI

Gibt einen Verweis auf das -Objekt zurück UIObject .

(Geerbt von _XDocument2)
URI

Ruft den URI (Uniform Resource Identifier) eines Formulars ab.

(Geerbt von _XDocument2)
Util

Ruft einen Verweis auf ein -Objekt ab UtilObject .

(Geerbt von _XDocument2)
View

Ruft einen Verweis auf die ab, die ViewObject einem Formular zugeordnet ist.

(Geerbt von _XDocument2)
ViewInfos

Ruft einen Verweis auf die Auflistung ab, die ViewInfosCollection einem Formular zugeordnet ist.

(Geerbt von _XDocument2)

Methoden

CreateDOM()

Erstellt im Speicher eine neue Instanz von XML-DOM (Document Object Model).

(Geerbt von _XDocument2)
GetDataVariable(Int32)

Ruft den Wert der angegebenen Variablen ab. Dabei handelt es sich um eine vordefinierte Variable, die als Verarbeitungsanweisungsattribut in dem einem Formular zugrunde liegenden XML-Dokument gespeichert ist.

(Geerbt von _XDocument2)
GetDOM(String)

Ruft einen Verweis auf das XML-DOM (Document Object Model) des angegebenen DataSourceObject Objekts ab, das dem XDocument -Objekt zugeordnet ist.

(Geerbt von _XDocument2)
GetNamedNodeProperty(Object, String, String)

Ruft den Wert einer benannten Eigenschaft für den angegebenen XML-Knoten ab, bei dem es sich um einen nonattribute (nicht attributierten) Knoten in der Hauptdatenquelle handeln muss.

(Geerbt von _XDocument2)
ImportDOM(IXMLDOMDocument)

Importiert die angegebenen XML-Daten in das aktuelle Formular.

(Geerbt von _XDocument2)
ImportFile(String)

Importiert das angegebene Formular in das aktuelle Formular.

(Geerbt von _XDocument2)
PrintOut()

Druckt den Formularinhalt so, wie er im Fenster entsprechend der aktiven Ansicht des Formulars gerendert wird.

(Geerbt von _XDocument2)
Query()

Ruft Daten aus dem einem Formular zugeordneten Datenadapterobjekt ab und speichert sie in dem einem Formular zugrunde liegenden XML-DOM-Element (Document Object Model).

(Geerbt von _XDocument2)
Save()

Speichert das Formular unter dem ihr zurzeit zugeordneten URL (Uniform Resource Locator).

(Geerbt von _XDocument2)
SaveAs(String)

Speichert das Formular unter dem angegebenen URL (Uniform Resource Locator).

(Geerbt von _XDocument2)
SetDataVariable(Int32, String)

Legt den Wert einer vordefinierten Variablen fest, die als Verarbeitungsanweisungsattribut in dem einem Formular zugrunde liegenden XML-Dokument gespeichert ist.

(Geerbt von _XDocument2)
SetDirty(Boolean)

Legt die IsDirty -Eigenschaft für das XDocument -Objekt fest, die angibt, ob die Daten in einem Formular seit dem letzten Speichern geändert wurden.

(Geerbt von _XDocument2)
SetNamedNodeProperty(IXMLDOMNode, String, String)

Legt den Wert einer benannten Eigenschaft für den bereitgestellten XML-Knoten fest, bei dem es sich um einen nonattribute (nicht attributierten) Knoten in der Hauptdatenquelle handeln muss.

(Geerbt von _XDocument2)
Submit()

Führt den vordefinierten Sendevorgang in einem Formular aus.

(Geerbt von _XDocument2)

Gilt für: