XmlForm Clase

Definición

Espacio de nombres:

Microsoft.Office.InfoPath

Ensamblado:

Microsoft.Office.InfoPath.dll

Representa el documento XML subyacente de un formulario.

public ref class XmlForm abstract

public abstract class XmlForm

type XmlForm = class

Public MustInherit Class XmlForm

Herencia

Object

XmlForm

Comentarios

La XmlForm clase es un objeto clave en el modelo de objetos de código administrado de InfoPath que proporciona propiedades, métodos y eventos que se pueden usar para interactuar mediante programación con y manipular los datos XML en el documento XML subyacente de un formulario.

Aunque XmlForm se puede acceder a los objetos desde la XmlFormCollection clase mediante la XmlForms propiedad de la clase , en la Application mayoría de los casos, al trabajar con la lógica de negocios de la plantilla de formulario, tendrá acceso a la XmlForm clase y a sus miembros mediante las palabras clave this (en C#) o Me (en Visual Basic) sin pasar por la colección.

Por ejemplo, los siguientes ejemplos de código de controladores de eventos para el Loading evento usan las palabras clave this o Me para acceder a las MainDataSource propiedades y NamespaceManager de la XmlForm clase . Estas propiedades se usan para trabajar con una instancia de la System.Xml. Campo empleado XPath.XPathNavigator (resolución de prefijos de espacio de nombres mediante la NamespaceManager propiedad ) y, a continuación, establezca el campo en el nombre de usuario del usuario actual.

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

Nota: No es necesario hacer referencia explícitamente a las palabras clave this o Me para acceder a los miembros de la clase en el XmlForm código de formulario. Por ejemplo, las líneas de código para acceder a la MainDataSource propiedad en los ejemplos anteriores de C# y Visual Basic se pueden escribir de la siguiente manera:

XPathNavigator myNav = MainDataSource.CreateNavigator()
Dim myNav As XPathNavigator = MainDataSource.CreateNavigator()

Sin embargo, el uso de las palabras clave this o Me al escribir código facilita la finalización de instrucciones de IntelliSense, que enumera los miembros de la XmlForm clase al escribir código de lógica de negocios en el módulo FormCode de una plantilla de formulario.

Al trabajar con código administrado, se obtiene acceso a los datos XML de origen de un formulario a través de la MainDataSource propiedad que devuelve una instancia de la DataSource clase que representa el origen de datos principal del formulario. A CreateNavigator() continuación, se usa el método de la DataSource clase para crear una instancia de la System.Xml. Clase XPath.XPathNavigator que se coloca en la raíz del documento XML subyacente del formulario. Después, se pueden usar los miembros de la clase XPathNavigator para ir a los datos del formulario, leerlos y escribir en ellos. Para obtener más información sobre el uso de la clase XPathNavigator en el código de formulario de InfoPath, vea How to: Work with System.Xml from Managed-code Form Templates.

La XmlForm clase también proporciona propiedades adicionales que se pueden usar para obtener información sobre el formulario y su documento XML subyacente. También proporciona métodos que se pueden utilizar para realizar diferentes acciones con el formulario, como imprimirlo, guardarlo y enviarlo. La clase implementa FormEvents eventos de nivel de formulario, como la carga de un formulario, el cambio de vistas o una operación de combinación. Además, la clase implementa los eventos generados por los cambios en el XmlEvents propio documento XML subyacente.

Se XmlForm puede acceder al objeto desde las XmlFormCollection clases y Window en el modelo de objetos de InfoPath. En la tabla siguiente se enumeran estas ubicaciones donde el XmlForm objeto está disponible.

XmlFormCollection	Se obtiene acceso desde el Application objeto mediante la XmlForms propiedad . Proporciona la propiedad y Microsoft.Office.InfoPath.XmlFormCollection.Open el Item[Int32] método para acceder a los XmlForm objetos que contiene.
Window	Proporciona la XmlForm propiedad para acceder al XmlForm objeto asociado a la ventana.

En el modelo de objetos de código administrado compatible con InfoPath 2003 (los tipos y miembros del Microsoft.Office.Interop.InfoPath.SemiTrust espacio de nombres), que se introdujo por primera vez en InfoPath 2003 Service Pack 1 junto con microsoft Office InfoPath 2003 Toolkit for Visual Studio .NET, las clases siguientes proporcionaron una propiedad XDocument para acceder al documento XML subyacente de un formulario durante eventos: DataDOMEventObjectClases , DocActionEventObject, DocEventObject, DocReturnEventObjecty VersionUpgradeEventObject .

En el nuevo modelo de objetos de código administrado de InfoPath (los tipos y miembros del Microsoft.Office.InfoPath espacio de nombres), se usan las palabras clave this (en C#) o Me (en Visual Basic) para acceder a la XmlForm clase y a sus miembros desde controladores de eventos y desde otro código de la lógica de negocios de la plantilla de formulario.

Constructores

XmlForm()

Representa el documento XML subyacente de un formulario.

Propiedades

CurrentView	Obtiene un View objeto que representa la vista actual del formulario.
DataConnections	Obtiene un DataConnectionCollection objeto asociado al formulario.
DataSources	Obtiene el DataSourceCollection objeto asociado al formulario.
Dirty	Obtiene o determina un valor que indica si los datos de un formulario han sido modificados desde la última vez que se guardó.
Environment	Obtiene un Environment objeto que proporciona información sobre el entorno en tiempo de ejecución (el editor de InfoPath, el explorador web o el explorador móvil) en el que se ejecuta el formulario.
Errors	Obtiene una referencia a que FormErrorCollection está asociada a un formulario.
Extension	Obtiene un Object para acceder a las funciones y variables globales contenidas en el archivo de código de formulario principal de un formulario mediante System.Reflection.
FormState	Obtiene una referencia a una bolsa de propiedades de tipo System.Collections.IDictionary que los formularios compatibles con exploradores pueden usar para conservar la información de estado de distintas sesiones en el servidor.
Host	Obtiene un objeto System.Object que puede usar el código que se ejecuta en una instancia hospedada de InfoPath para tener acceso al modelo de objetos de la aplicación de hospedaje.
Hosted	Obtiene información sobre si InfoPath está hospedada como control en otra aplicación.
HostName	Obtiene el nombre de la aplicación que hospeda a InfoPath como control.
MainDataSource	Obtiene un DataSource objeto que representa el origen de datos principal del formulario.
NamespaceManager	Obtiene una referencia a un XmlNamespaceManager objeto que se puede usar para resolver, agregar o quitar espacios de nombres usados en el formulario.
NetworkState	Obtiene un NetworkState objeto que proporciona información sobre el estado de conexión del equipo cliente o si se puede realizar una conexión al destino de red especificado.
New	Obtiene un valor que especifica si un formulario es nuevo.
Permission	Obtiene una referencia a un Permission objeto asociado al formulario.
QueryDataConnection	Obtiene una referencia al DataConnection objeto que representa la conexión de datos asociada al formulario.
ReadOnly	Obtiene un valor que indica si una plantilla de formulario es de sólo lectura o está bloqueada.
Recovered	Obtiene un valor que indica si un formulario se guardó la última vez mediante una operación de guardado de Autorrecuperación.
ServerInfo	Obtiene un ServerInfo objeto que proporciona información sobre el servidor de SharePoint donde se encuentra el formulario.
Signed	Obtiene un valor que indica si un formulario se ha firmado digitalmente mediante firmas digitales.
SignedDataBlocks	Obtiene una referencia a la SignedDataBlockCollection colección asociada a un formulario.
TaskPanes	Obtiene una referencia a que TaskPaneCollection está asociada a una plantilla de formulario.
Template	Obtiene una referencia al FormTemplate objeto que representa el manifiesto (.xsf) de la plantilla de formulario asociada al formulario.
Uri	Obtiene el identificador uniforme de recursos (URI) de un formulario.
User	Obtiene un User objeto que proporciona información sobre el usuario actual del formulario.
UserRole	Obtiene o establece el usuario actual del nombre del rol del formulario.
ViewInfos	Obtiene una referencia al ViewInfoCollection objeto asociado a la plantilla de formulario.
XmlLang	Obtiene o determina el valor del atributo xml:lang del documento XML subyacente del formulario.

Métodos

Close()	Cierra el formulario.
GetWorkflowTasks()	Obtiene una referencia a una colección Microsoft.Office.Core.WorkflowTasks para el formulario actual.
GetWorkflowTemplates()	Obtiene una referencia a la colección Microsoft.Office.Core.WorkflowTemplates para el formulario actual.
MergeForm(String)	Combina el formulario actual con el formulario especificado mediante la ruta de acceso o la dirección URL.
MergeForm(XPathNavigator)	Combina el formulario actual con el formulario de destino especificado en el nodo devuelto por el XPathNavigator pasado al método .
NotifyHost(String)	Proporciona un valor personalizado para la aplicación host o la página ASPX.
Print()	Imprime el contenido del formulario mientras se presenta en la vista activa del formulario.
Print(Boolean)	Imprime el contenido del formulario mientras se presenta la vista activa del formulario, mostrando el cuadro de diálogo Imprimir.
Save()	Guarda el formulario en la dirección URL a la que esté asociado actualmente.
SaveAs(String)	Guarda el formulario en la dirección URL especificada.
SetSaveAsDialogFilename(String)	Establece el nombre de archivo predeterminado para el cuadro de diálogo Guardar como.
SetSaveAsDialogLocation(String)	Establece la ruta de acceso predeterminada para guardar el formulario mediante el cuadro de diálogo Guardar como.
Submit()	Envía el formulario mediante la operación de envío definida en la plantilla de formulario.