XmlForm Klasse
Definition
Wichtig
Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.
Stellt das zugrunde liegende XML-Dokument eines Formulars dar.
public ref class XmlForm abstract
public abstract class XmlForm
type XmlForm = class
Public MustInherit Class XmlForm
- Vererbung
-
XmlForm
Hinweise
Die XmlForm -Klasse ist ein Schlüsselobjekt im InfoPath-Objektmodell mit verwaltetem Code, das Eigenschaften, Methoden und Ereignisse bereitstellt, die für die programmgesteuerte Interaktion und Bearbeitung der XML-Daten im zugrunde liegenden XML-Dokument eines Formulars verwendet werden können.
Während XmlForm der Zugriff auf Objekte über die XmlFormCollection -Klasse mithilfe der XmlForms -Eigenschaft der Application -Klasse möglich ist, greifen Sie in den meisten Fällen beim Arbeiten mit der Geschäftslogik von Formularvorlagen auf die XmlForm Klasse und ihre Member zu, indem Sie die Schlüsselwörter this (in C#) oder Me (in Visual Basic) verwenden, ohne die Auflistung zu durchlaufen.
Beispielsweise verwenden die folgenden Codebeispiele von Ereignishandlern für das Loading Ereignis die Schlüsselwörter this oder Me , um auf die MainDataSource Eigenschaften und NamespaceManager der XmlForm -Klasse zuzugreifen. Diese Eigenschaften werden verwendet, um mit einer instance desSystem.Xml zu arbeiten . XPath.XPathNavigator-Mitarbeiterfeld (Auflösen von Namespacepräfixen mithilfe der NamespaceManager -Eigenschaft), und legen Sie dann das Feld auf den Benutzernamen des aktuellen Benutzers fest.
public void FormEvents_Loading(object sender, LoadingEventArgs e)
{
// Create XPathNavigator positioned at the root of the main data
// source.
XPathNavigator myNav = this.MainDataSource.CreateNavigator()
// Select employee field and set value to username.
myNav.SelectSingleNode("//my:employee",this.NamespaceManager).
SetValue(System.Environment.UserName);
}
Public Sub FormEvents_Loading(ByVal sender As Object, ByVal e As LoadingEventArgs)
' Create XPathNavigator positioned at the root of the main data
' source.
Dim myNav As XPathNavigator = Me.MainDataSource.CreateNavigator()
' Select employee field and set value to username.
myNav.SelectSingleNode("//my:employee", Me.NamespaceManager). _
SetValue(System.Environment.UserName)
End Sub
Hinweis: Es ist nicht erforderlich, explizit auf die Schlüsselwörter this oder Me zu verweisen, um im Formularcode auf die Member der XmlForm -Klasse zuzugreifen. Die Codezeilen für den Zugriff auf die Eigenschaft in den MainDataSource vorherigen C#- und Visual Basic-Beispielen können beispielsweise wie folgt geschrieben werden:
XPathNavigator myNav = MainDataSource.CreateNavigator()
Dim myNav As XPathNavigator = MainDataSource.CreateNavigator()
Die Verwendung der Schlüsselwörter this oder Me beim Schreiben von Code erleichtert jedoch die Vervollständigung von IntelliSense-Anweisungen, die die Member der XmlForm Klasse beim Schreiben von Geschäftslogikcode im FormCode-Modul einer Formularvorlage auflistet.
Beim Arbeiten mit verwaltetem Code wird auf die XML-Quelldaten eines Formulars über die MainDataSource -Eigenschaft zugegriffen, die eine instance der DataSource Klasse zurückgibt, die die Standard Datenquelle des Formulars darstellt. Die CreateNavigator() -Methode der DataSource -Klasse wird dann verwendet, um eine instance desSystem.Xml zu erstellen . XPath.XPathNavigator-Klasse, die im Stammverzeichnis des dem Formular zugrunde liegenden XML-Dokuments positioniert ist. Die Member der XPathNavigator-Klasse können anschließend verwendet werden, um zu den Formulardaten zu navigieren und diese zu lesen und in sie zu schreiben. Weitere Informationen zur Verwendung der XPathNavigator-Klasse in InfoPath-Formularcode finden Sie unter Vorgehensweise: Arbeiten mit System.Xml aus Formularvorlagen mit verwaltetem Code.
Die XmlForm -Klasse stellt auch zusätzliche Eigenschaften bereit, mit denen Informationen zum Formular und dem zugrunde liegenden XML-Dokument abgerufen werden können. Sie stellt außerdem Methoden zum Ausführen verschiedener Formularaktionen bereit, z. B. Drucken, Speichern oder Absenden. Ereignisse auf Formularebene, z. B. das Laden eines Formulars, das Wechseln von Ansichten oder ein Zusammenführungsvorgang, werden von der FormEvents -Klasse implementiert. Darüber hinaus werden Ereignisse, die durch Änderungen am zugrunde liegenden XML-Dokument selbst ausgelöst werden, von der XmlEvents -Klasse implementiert.
Auf XmlForm das Objekt kann über die XmlFormCollection Klassen und Window im InfoPath-Objektmodell zugegriffen werden. In der folgenden Tabelle sind diese Speicherorte aufgeführt, an denen das XmlForm Objekt verfügbar ist.
XmlFormCollection | Zugriff über das Application -Objekt mithilfe der XmlForms -Eigenschaft. Stellt die -Eigenschaft und Microsoft.Office.InfoPath.XmlFormCollection.Open -Item[Int32]Methode für den Zugriff auf die XmlForm darin enthaltenen Objekte bereit. |
Window | Stellt die -Eigenschaft für den XmlForm Zugriff auf das XmlForm -Objekt bereit, das dem Fenster zugeordnet ist. |
Im InfoPath 2003-kompatiblen Objektmodell mit verwaltetem Code (die Typen und Member des Microsoft.Office.Interop.InfoPath.SemiTrust Namespace), das erstmals in InfoPath 2003 Service Pack 1 in Verbindung mit dem Microsoft Office InfoPath 2003 Toolkit für Visual Studio .NET eingeführt wurde, stellten die folgenden Klassen eine XDocument-Eigenschaft für den Zugriff auf das zugrunde liegende XML-Dokument eines Formulars während ereignissen bereit: DataDOMEventObject-DocActionEventObject, -, DocEventObjectDocReturnEventObject-, - und VersionUpgradeEventObject -Klassen.
Im neuen InfoPath-Objektmodell mit verwaltetem Code (die Typen und Member des Microsoft.Office.InfoPath Namespace) verwenden Sie die Schlüsselwörter this (in C#) oder Me (in Visual Basic), um über Ereignishandler und anderen Code in Ihrer Formularvorlagen-Geschäftslogik auf die XmlForm Klasse und ihre Member zuzugreifen.
Konstruktoren
XmlForm() |
Stellt das zugrunde liegende XML-Dokument eines Formulars dar. |
Eigenschaften
CurrentView |
Ruft ein View -Objekt ab, das die aktuelle Ansicht des Formulars darstellt. |
DataConnections |
Ruft ein DataConnectionCollection -Objekt ab, das dem Formular zugeordnet ist. |
DataSources |
Ruft das DataSourceCollection -Objekt ab, das dem Formular zugeordnet ist. |
Dirty |
Ruft einen Wert ab, der angibt, ob die Daten in einem Formular seit dem letzten Speichern geändert wurden, oder legt diesen Wert fest. |
Environment |
Ruft ein Environment -Objekt ab, das Informationen darüber bereitstellt, in welcher Laufzeitumgebung (InfoPath-Editor, Webbrowser oder mobiler Browser) das Formular ausgeführt wird. |
Errors |
Ruft einen Verweis auf die ab, die FormErrorCollection einem Formular zugeordnet ist. |
Extension |
Ruft einen Object für den Zugriff auf die Funktionen und globalen Variablen ab, die in der primären Formularcodedatei eines Formulars mithilfe von System.Reflection enthalten sind. |
FormState |
Ruft einen Verweis auf eine Eigenschaftensammlung vom Typ System.Collections.IDictionary ab, der von browserfähigen Formularen zum Beibehalten von Statusinformationen in allen Sitzungen auf dem Server verwendet werden kann. |
Host |
Ruft System.Object ab, mit Zugriffsmöglichkeit auf das Objektmodell der Hostanwendung mittels Code, das in einer gehosteten Instanz von InfoPath ausgeführt wird. |
Hosted |
Ruft ab, ob InfoPath in einer anderen Anwendung als Steuerelement gehostet wird. |
HostName |
Ruft den Namen der Anwendung ab, mit der InfoPath als Steuerelement gehostet wird. |
MainDataSource |
Ruft ein DataSource -Objekt ab, das die Standard Datenquelle des Formulars darstellt. |
NamespaceManager |
Ruft einen Verweis auf ein XmlNamespaceManager -Objekt ab, das zum Auflösen, Hinzufügen oder Entfernen von Namespaces verwendet werden kann, die im Formular verwendet werden. |
NetworkState |
Ruft ein NetworkState -Objekt ab, das Informationen zum Verbindungsstatus des Clientcomputers bereitstellt oder ob eine Verbindung mit dem angegebenen Netzwerkziel hergestellt werden kann. |
New |
Ruft einen Wert ab, der angibt, ob ein Formular neu ist. |
Permission |
Ruft einen Verweis auf ein Permission -Objekt ab, das dem Formular zugeordnet ist. |
QueryDataConnection |
Ruft einen Verweis auf das DataConnection -Objekt ab, das die Datenverbindung darstellt, die dem Formular zugeordnet ist. |
ReadOnly |
Ruft einen Wert ab, der angibt, ob eine Formularvorlage schreibgeschützt oder gesperrt ist. |
Recovered |
Ruft einen Wert ab, der angibt, ob ein Formular zuletzt mithilfe eines AutoWiederherstellen-Speichervorgangs gespeichert wurde. |
ServerInfo |
Ruft ein ServerInfo -Objekt ab, das Informationen zum SharePoint-Server bereitstellt, auf dem sich das Formular befindet. |
Signed |
Ruft einen Wert ab, der angibt, ob ein Formular mithilfe digitaler Signaturen digital signiert wurde. |
SignedDataBlocks |
Ruft einen Verweis auf die SignedDataBlockCollection Auflistung ab, die einem Formular zugeordnet ist. |
TaskPanes |
Ruft einen Verweis auf die ab, die TaskPaneCollection einer Formularvorlage zugeordnet ist. |
Template |
Ruft einen Verweis auf das FormTemplate -Objekt ab, das das Manifest (.xsf) der Formularvorlage darstellt, die dem Formular zugeordnet ist. |
Uri |
Ruft den URI (Uniform Resource Identifier) eines Formulars ab. |
User |
Ruft ein User -Objekt ab, das Informationen zum aktuellen Benutzer des Formulars bereitstellt. |
UserRole |
Ruft den aktuellen Benutzer des Rollennamens im Formular ab oder legt diesen fest. |
ViewInfos |
Ruft einen Verweis auf das -Objekt ab, das ViewInfoCollection der Formularvorlage zugeordnet ist. |
XmlLang |
Ruft den Wert des xml:lang-Attributs im zugrunde liegenden XML-Dokument des Formulars ab, oder legt diesen fest. |
Methoden
Close() |
Schließt das Formular. |
GetWorkflowTasks() |
Ruft einen Verweis auf die Microsoft.Office.Core.WorkflowTasks-Auflistung des aktuellen Formulars ab. |
GetWorkflowTemplates() |
Ruft einen Verweis auf die Microsoft.Office.Core.WorkflowTemplates-Auflistung des aktuellen Formulars ab. |
MergeForm(String) |
Führt das aktuelle Formular mit dem über den Pfad oder URL angegebenen Formular zusammen. |
MergeForm(XPathNavigator) |
Führt das aktuelle Formular mit dem Zielformular zusammen, das im Knoten angegeben ist, der von dem zurückgegeben wird, das XPathNavigator an die -Methode übergeben wird. |
NotifyHost(String) |
Stellt einen benutzerdefinierten Wert für die Hostanwendung oder ASPX-Seite (Active Server Page Extension) bereit. |
Print() |
Druckt den Formularinhalt so, wie er in der aktiven Ansicht des Formulars gerendert wird. |
Print(Boolean) |
Druckt den Formularinhalt so, wie er in der aktiven Ansicht des Formulars gerendert wird, indem das Dialogfeld Drucken angezeigt wird. |
Save() |
Speichert das Formular unter dem ihr zurzeit zugeordneten URL (Uniform Resource Locator). |
SaveAs(String) |
Speichert das Formular unter dem angegebenen URL (Uniform Resource Locator). |
SetSaveAsDialogFilename(String) |
Legt den Standarddateinamen für das Dialogfeld Speichern unter fest. |
SetSaveAsDialogLocation(String) |
Legt den Standardpfad zum Speichern des Formulars mithilfe des Dialogfeldes Speichern unter fest. |
Submit() |
Sendet das Formular mithilfe des in der Formularvorlage definierten Sendevorgangs. |