Utilizar código de limpieza e inicialización mediante el modelo de objetos de InfoPath 2003

Artículo
04/27/2010

De manera predeterminada, el archivo FormCode.cs o FormCode.vb que se crea para un proyecto nuevo de plantillas de formulario compatible con InfoPath 2003 contiene todo el código fuente de la lógica de programación del formulario. La plantilla del proyecto genera en este archivo una clase parecida a las de los ejemplos siguientes, en los que se puede definir el código de limpieza e inicialización, además de los controladores de los eventos del formulario. Los archivos FormCode.cs y FormCode.vb se aplican a un atributoSystem.ComponentModel.DescriptionAttribute de nivel de ensamblado, que identifica la clase como la única en la que se implementan los controladores de eventos. El atributo InfoPathNamespace (que implementa el tipo InfoPathNamespaceAttribute) se aplica a una clase para identificar los espacios de nombres de selección del XML DOM que se utilizan dentro de la clase. El sistema de proyectos de InfoPath mantiene los espacios de nombres a los que se hace referencia en InfoPathNamespace.

La clase FormCode proporciona los métodos _Startup y _Shutdown, que se emplean para llevar a cabo rutinas de inicialización y limpieza de cualquier componente que sea necesario para complementar la funcionalidad estándar de InfoPath mientras está abierto el formulario.

Importante

No llame a los miembros del modelo de objetos de InfoPath desde los métodos _Startup y _Shutdown. Sólo debe inicializar y llamar a miembros de componentes externos de estos métodos.

using System;
using Microsoft.Office.Interop.InfoPath.SemiTrust;

// Office integration attribute. Identifies the startup class for the form. Do not
// modify.
[assembly: System.ComponentModel.DescriptionAttribute(
    "InfoPathStartupClass, Version=1.0, Class=Template1.FormCode")]

namespace Template1
{
    // The namespace prefixes defined in this attribute must remain synchronized with
    // those in the form definition file (.xsf).
    [InfoPathNamespace(
        "xmlns:my='https://schemas.microsoft.com/office/infopath/2003/myXSD/2004-03-29T22-27-27'")]
    public partial class FormCode
    {
        private XDocument thisXDocument;
        private Application thisApplication;

        public void _Startup(Application app, XDocument doc)
        {
            thisXDocument = doc;
            thisApplication = app;

            // You can add additional initialization code here.
        }

        public void _Shutdown()
        {
        }
    }
}
Imports System
Imports Microsoft.Office.Interop.InfoPath.SemiTrust
Imports Microsoft.VisualBasic

' Office integration attribute. Identifies the startup class for the form. Do not
' modify.
<Assembly: System.ComponentModel.DescriptionAttribute( _
    "InfoPathStartupClass, Version=1.0, Class=Template1.FormCode")>

Namespace Template1
    ' The namespace prefixes defined in this attribute must remain synchronized with
    ' those in the form definition file (.xsf).
    <InfoPathNamespace( _
        "xmlns:my='https://schemas.microsoft.com/office/infopath/2003/myXSD/2004-03-29T22-36-40'")> _
    Public Class FormCode

        Private thisXDocument As XDocument
        Private thisApplication As Application

        Public Sub _Startup(app As Application, doc As XDocument)
            thisXDocument = doc
            thisApplication = app

            ' You can add additional initialization code here.
        End Sub

        Public Sub _Shutdown()
        End Sub
    End Class
End Namespace

Método _Startup

Además de proporcionar una ubicación para escribir el código de inicialización de los componentes adicionales, el método _Startup inicializa las variables thisXDocument y thisApplication, que se pueden emplear en el código del formulario para obtener acceso a los miembros de las clases XDocument y Application del modelo de objetos de InfoPath. La plantilla de proyectos de Visual Studio genera automáticamente el código necesario para inicializar las dos variables.

    private XDocument thisXDocument;
    private Application thisApplication;

    public void _Startup(Application app, XDocument doc)
    {
        thisXDocument = doc;
        thisApplication = app;

        // You can add additional initialization code here.
    }
    Private thisXDocument As XDocument
    Private thisApplication As Application

    Public Sub _Startup(app As Application, doc As XDocument)
        thisXDocument = doc
        thisApplication = app

        ' You can add additional initialization code here.
    End Sub

Los ejemplos siguientes muestran un controlador de eventos simple para un botón que utiliza la variable thisXDocument para obtener acceso al método Alert del tipo UIObject.

[InfoPathEventHandler(MatchPath="CTRL1_5", EventType=InfoPathEventType.OnClick)]
public void CTRL1_5_OnClick(DocActionEvent e)
{
    // Write your code here.
    thisXDocument.UI.Alert("Hello!");
}
<InfoPathEventHandler(MatchPath:="CTRL1_5", EventType:=InfoPathEventType.OnClick)> _
Public Sub CTRL1_5_OnClick(ByVal e As DocActionEvent)
    ' Write your code here.
    thisXDocument.UI.Alert("Hello!")
End Sub

Para obtener más información sobre cómo crear controladores de eventos, vea Cómo: Agregar un controlador de eventos mediante el modelo de objetos de InfoPath 2003.

Método _ShutDown

El método _Shutdown es el último método al que se llama cuando se cierra un formulario. Puede escribir cualquier tipo de código en este método necesario para limpiar o finalizar los componentes utilizados en el formulario.

    public void _Shutdown()
    {
    }
    Public Sub _Shutdown()
    End    Sub

Ejemplo de código de limpieza e inicialización

En el ejemplo siguiente, se muestra cómo inicializar una conexión a una base de datos de Microsoft SQL Server™ en el método _Startup y cerrar la conexión en el método _Shutdown. Para que este ejemplo funcione correctamente, primero debe establecer una referencia al ensamblado System.Data de .NET Framework, haciendo clic en la opción Agregar referencia del menú Proyecto y, después, seleccionar el componente System.Data.dll en la ficha .NET. Tenga en cuenta, además, que la directiva using System.Data.SqlClient (o Imports System.Data.SqlClient) se agrega al principio del archivo de código del formulario para reducir el número de pulsaciones.

Nota

Puede que los usuarios de un formulario de InfoPath que contenga código que se conecte a una base de datos de SQL necesiten permisos de seguridad según la forma en que se implemente el formulario y cómo se defina la directiva de seguridad. Para obtener más información sobre seguridad, vea los temas Acerca del modelo de seguridad de las plantillas de formulario con código administrado y Cómo: Configurar las opciones de seguridad de las plantillas de formulario con código administrado.

using System;
using System.Data.SqlClient;
using Microsoft.Office.Interop.InfoPath.SemiTrust;

// Office integration attribute. Identifies the startup class for the form. Do not
// modify.
[assembly: System.ComponentModel.DescriptionAttribute(
    "InfoPathStartupClass, Version=1.0, Class=Template1.FormCode")]

namespace Template1
{
    // The namespace prefixes defined in this attribute must remain synchronized with
    // those in the form definition file (.xsf).
    [InfoPathNamespace(
        "xmlns:my='https://schemas.microsoft.com/office/infopath/2003/myXSD/2004-03-05T20-56-13'")]
    public partial class Template1
    {
        private XDocument    thisXDocument;
        private Application    thisApplication;
        private SqlConnection sqlConnect;

        public void _Startup(Application app, XDocument doc)
        {
            thisXDocument = doc;
            thisApplication = app;

            // Initialize variable for SQL Server connection.
            sqlConnect= new SqlConnection("server=localhost;Trusted_Connection=yes;database=Northwind");
        }

        public void _Shutdown()
        {
            // Close SQL Server connection at shut down.
            sqlConnect.Close();
        }
    }
}
Imports System
Imports System.Data.SqlClient
Imports Microsoft.Office.Interop.InfoPath.SemiTrust
Imports Microsoft.VisualBasic

' Office integration attribute. Identifies the startup class for the form. Do not
' modify.
<Assembly: System.ComponentModel.DescriptionAttribute( _
    "InfoPathStartupClass, Version=1.0, Class=Template1.FormCode")>

Namespace Template1
        ' The namespace prefixes defined in this attribute must remain synchronized with
        ' those in the form definition file (.xsf).
        <InfoPathNamespace( _
            "xmlns:my='https://schemas.microsoft.com/office/infopath/2003/myXSD/2004-03-08T18-47-33'")>        _
        Public Class Template1

            Private thisXDocument As XDocument
            Private thisApplication As Application
            Private sqlConnect As SqlConnection

            Public Sub _Startup(app As Application, doc As XDocument)
                thisXDocument = doc
                thisApplication = app

                ' Initialize variable for SQL Server connection.
                sqlConnect = New SqlConnection _("server=localhost;Trusted_Connection=yes;database=Northwind")
            End Sub

        Public Sub _Shutdown()
            ' Close SQL Server connection.
            sqlConnect.Close()
        End Sub
    End Class
End Namespace

Vea también

Tareas

Cómo: Agregar un controlador de eventos mediante el modelo de objetos de InfoPath 2003

Share via