C# - [WinForms] Instancia Única de Formulario

 

Introducción

---

La manipulación de las instancias de un formulario en algunas circunstancias puede no ser tan simple como aparenta.

Note en algunas oportunidades la necesidad que solo tener una única instancia, además de poder controlar las acciones o eventos que se ejecuten sobre este formulario, pero desde quien  realiza la apertura.

 

Ejemplo sobre Formularios  Simples

---

Para comenzar a ver este tema lo haremos en un primer ejemplo simple con formularios comunes.

Para esto tendremos un formulario que podrá denominarse Principal, el cual tiene dos botones, uno hará uso de instancias únicas, mientras que el segundo creara muchas instancias de ese formulario

 

public partial class Form1 : Form
{
    public Form1()
    {
        InitializeComponent();
    }

    private Form2 form = null;

    private Form2 FormInstance
    {
        get
        {
            if (form == null)
            {
                form = new Form2();
                form.Disposed += new EventHandler(form_Disposed);
            }

            return form;
        }
    }

    void form_Disposed(object sender, EventArgs e)
    {
        form = null;
    }


    private void btnAbrirUnicaInstanciaForm_Click(object sender, EventArgs e)
    {
        Form2 frm = this.FormInstance;
         
        frm.Text = "Unica Instancia";
        frm.Show();

        // si el Formulario estaba abierto seguramente este en segundo plano
        // con esta linea hacemos que pase adelante
        frm.BringToFront();
    }

    private void btnAbrirInstanciaMultiplesForm_Click(object sender, EventArgs e)
    {
        Form2 frm = new Form2();

        frm.Text = "Instancia Multiple";
        frm.Show();
    }
}

El punto importante en este código y que marca la diferencia es el uso de la propiedad de nombre “FormInstance” esta propiedad permitirá aplicar la lógica que valide si ya existe una instancia creada para el formulario.

Si se analiza el código de la propiedad se notara que hace uso de una propiedad privada global al formulario, la idea es siempre crear y acceder al formulario a través de la propiedad y nunca hacer uso de la variable privada.

Es la propiedad la que provee del encapsulamiento de la lógica para determinar la reutilización de la instancia del formulario.

Hay un detalle adicional que por ahí noten como extraño, dentro de la propiedad al crear la instancia se adiciona el handler de un evento “Disposed”, seguramente se preguntaran cual es el objetivo de este evento.

Cuando se crea la instancia del formulario la variable privada contiene dicha instancia, pero al cerrarse el formulario la variable seguirá manteniendo el puntero cuando ya no sea una referencia valida, pues el formulario ha sido destruido, el tema es que nunca se reflejo esto en la variable privada. El uso del evento informa al formulario que realiza la apertura de la destrucción al cierre del formulario para que pueda quitar la referencia de la variable, en este caso simplemente igualándola a null.

Es importante también notar la diferencia en como se crea una instancia que es única, y cuando es múltiple, cuando se permiten muchas instancias solo basta con hacer uso del operador new cada vez que se quiere una nueva.

 

Formularios MDI

---

Como segundo ejemplo veremos como hacer esto mismo pero dentro de un formularios MDI, al cual le hemos agregado algunas otras tareas.

Básicamente la técnica es la misma, una propiedad en el formulario que valida la existencia de una instancia del formulario, pero en este caso en particular se han agregado algunos eventos adicionales que se querían trabajar desde el formulario que realiza la apertura.

Como se ver se hace uso de los eventos Load y FormClosed para poder informar en un StatusTrip de estas acciones.

 

public partial class frmPrincipalMDI : Form
{
    public frmPrincipalMDI()
    {
        InitializeComponent();
    }

    private frmSecundario form = null;

    private frmSecundario FormInstance
    {
        get
        {
            if (form == null)
            {
                form = new frmSecundario();
                form.MdiParent = this;

                form.Disposed += new EventHandler(form_Disposed);
                form.FormClosed += new FormClosedEventHandler(form_FormClosed);
                form.Load += new EventHandler(form_Load); 
                
            }

            return form;
        }
    }

    void form_Load(object sender, EventArgs e)
    {
        tslMensaje.Text = "Formulario abierto";
    }

    void form_FormClosed(object sender, FormClosedEventArgs e)
    {
        tslMensaje.Text = "Se ha cerrado el Formulario";
    }

    void form_Disposed(object sender, EventArgs e)
    {
        form = null;
    }


    private void instanciaUnicaToolStripMenuItem_Click(object sender, EventArgs e)
    {
        frmSecundario frm = this.FormInstance;

        // se varifica si el formulario no esta minimizado, en caso de estarlo
        // se lo cambia a un estado normal
        if (frm.WindowState == FormWindowState.Minimized)
            frm.WindowState = FormWindowState.Normal; 

        frm.Show(); 
    }

    private void instanciaMultipleToolStripMenuItem_Click(object sender, EventArgs e)
    {
        frmSecundario frm = new frmSecundario();
        frm.MdiParent = this;

        frm.Show();
    }
}

[C#]

[VB.NET]