IComponentChangeService Interfaz

Definición

Espacio de nombres:

System.ComponentModel.Design

Ensamblado:

System.ComponentModel.TypeConverter.dll

Proporciona una interfaz para agregar y quitar los controladores de eventos que agregan, cambian, quitan o cambian de nombre componentes, y proporciona métodos para iniciar un evento ComponentChanged o ComponentChanging.

C#

public interface IComponentChangeService

Ejemplos

En este ejemplo siguiente se muestra cómo usar la IComponentChangeService interfaz para recibir notificaciones sobre la adición, eliminación de y cambios en los componentes en modo de diseño.

C#

using System;
using System.Data;
using System.Drawing;
using System.Collections;
using System.ComponentModel;
using System.ComponentModel.Design;
using System.Windows.Forms;

/*  This sample illustrates how to use the IComponentChangeService interface 
    to handle component change events.  The ComponentClass control attaches 
    event handlers when it is sited in a document, and displays a message 
    when notification that a component has been added, removed, or changed
    is received from the IComponentChangeService.

    To run this sample, add the ComponentClass control to a Form and
    add, remove, or change components to see the behavior of the
    component change event handlers. */

namespace IComponentChangeServiceExample 
{
    public class ComponentClass : System.Windows.Forms.UserControl 
    {
        private System.ComponentModel.Container components = null;
    private System.Windows.Forms.ListBox listBox1;
    private IComponentChangeService m_changeService;
 
    public ComponentClass() 
    {
        InitializeComponent();
    }

    private void InitializeComponent() 
    {
        this.listBox1 = new System.Windows.Forms.ListBox();
        this.SuspendLayout();

        // listBox1.
        this.listBox1.Location = new System.Drawing.Point(24, 16);
        this.listBox1.Name = "listBox1";
        this.listBox1.Size = new System.Drawing.Size(576, 277);
        this.listBox1.TabIndex = 0;
           
        // ComponentClass.
        this.Controls.AddRange(new System.Windows.Forms.Control[] {this.listBox1});
        this.Name = "ComponentClass";
        this.Size = new System.Drawing.Size(624, 320);

            this.ResumeLayout(false);
    }

    // This override allows the control to register event handlers for IComponentChangeService events
    // at the time the control is sited, which happens only in design mode.
    public override ISite Site 
    {
        get 
        {
        return base.Site;
        }
        set 
        {		
        // Clear any component change event handlers.
        ClearChangeNotifications();		
                
        // Set the new Site value.
        base.Site = value;

        m_changeService = (IComponentChangeService)GetService(typeof(IComponentChangeService));

        // Register event handlers for component change events.
        RegisterChangeNotifications();			
        }
    }

    private void ClearChangeNotifications()
    {
        // The m_changeService value is null when not in design mode, 
        // as the IComponentChangeService is only available at design time.	
        m_changeService = (IComponentChangeService)GetService(typeof(IComponentChangeService));

        // Clear our the component change events to prepare for re-siting.				
        if (m_changeService != null) 
        {
        m_changeService.ComponentChanged -= new ComponentChangedEventHandler(OnComponentChanged);
        m_changeService.ComponentChanging -= new ComponentChangingEventHandler(OnComponentChanging);
        m_changeService.ComponentAdded -= new ComponentEventHandler(OnComponentAdded);
        m_changeService.ComponentAdding -= new ComponentEventHandler(OnComponentAdding);
        m_changeService.ComponentRemoved -= new ComponentEventHandler(OnComponentRemoved);
        m_changeService.ComponentRemoving -= new ComponentEventHandler(OnComponentRemoving);
        m_changeService.ComponentRename -= new ComponentRenameEventHandler(OnComponentRename);
        }
    }

    private void RegisterChangeNotifications()
    {
        // Register the event handlers for the IComponentChangeService events
        if (m_changeService != null) 
        {
        m_changeService.ComponentChanged += new ComponentChangedEventHandler(OnComponentChanged);
        m_changeService.ComponentChanging += new ComponentChangingEventHandler(OnComponentChanging);
        m_changeService.ComponentAdded += new ComponentEventHandler(OnComponentAdded);
        m_changeService.ComponentAdding += new ComponentEventHandler(OnComponentAdding);
        m_changeService.ComponentRemoved += new ComponentEventHandler(OnComponentRemoved);
        m_changeService.ComponentRemoving += new ComponentEventHandler(OnComponentRemoving);
        m_changeService.ComponentRename += new ComponentRenameEventHandler(OnComponentRename);
        }
    }

    /* This method handles the OnComponentChanged event to display a notification. */
    private void OnComponentChanged(object sender, ComponentChangedEventArgs ce) 
    {
        if( ce.Component != null && ((IComponent)ce.Component).Site != null && ce.Member != null ) 
        OnUserChange("The " + ce.Member.Name + " member of the " + ((IComponent)ce.Component).Site.Name + " component has been changed.");
    }

    /* This method handles the OnComponentChanging event to display a notification. */
    private void OnComponentChanging(object sender, ComponentChangingEventArgs ce) 
    {
        if( ce.Component != null && ((IComponent)ce.Component).Site != null && ce.Member != null ) 
        OnUserChange("The " + ce.Member.Name + " member of the " + ((IComponent)ce.Component).Site.Name + " component is being changed.");
    }

    /* This method handles the OnComponentAdded event to display a notification. */
    private void OnComponentAdded(object sender, ComponentEventArgs ce) 
    {			
        OnUserChange("A component, " + ce.Component.Site.Name + ", has been added.");
    }

    /* This method handles the OnComponentAdding event to display a notification. */		
    private void OnComponentAdding(object sender, ComponentEventArgs ce) 
    {			
        OnUserChange("A component of type " + ce.Component.GetType().FullName + " is being added.");
    }

    /* This method handles the OnComponentRemoved event to display a notification. */
    private void OnComponentRemoved(object sender, ComponentEventArgs ce) 
    {
        OnUserChange("A component, " + ce.Component.Site.Name + ", has been removed.");
    }

    /* This method handles the OnComponentRemoving event to display a notification. */
    private void OnComponentRemoving(object sender, ComponentEventArgs ce) 
    {
        OnUserChange("A component, " + ce.Component.Site.Name + ", is being removed.");
    }

    /* This method handles the OnComponentRename event to display a notification. */
    private void OnComponentRename(object sender, ComponentRenameEventArgs ce) 
    {
        OnUserChange("A component, " + ce.OldName + ", was renamed to " + ce.NewName +".");
    }

    // This method adds a specified notification message to the control's listbox.
    private void OnUserChange(string text) 
    {
        listBox1.Items.Add(text);
    }

    // Clean up any resources being used.
    protected override void Dispose( bool disposing ) 
    {
        if( disposing ) 
        {
        ClearChangeNotifications();
            
        if(components != null) 
        {
            components.Dispose();
        }
        }
        base.Dispose( disposing );
    }
    }
}

Comentarios

IComponentChangeService proporciona una interfaz que se puede usar para indicar los métodos que controlan los siguientes eventos:

• ComponentAdded, se genera cuando se agrega un componente.

• ComponentAdding, se genera cuando un componente está a punto de agregarse.

• ComponentChanged, se genera cuando se cambia un componente.

• ComponentChanging, se genera cuando un componente está a punto de cambiarse.

• ComponentRemoved, se genera cuando se quita un componente.

• ComponentRemoving, se genera cuando un componente está a punto de quitarse.

• ComponentRename, se genera cuando se cambia el nombre de un componente.

Normalmente, el entorno de diseño genera estos eventos de adición, cambio, eliminación o cambio de nombre de componentes. Los diseñadores deben llamar a los métodos de esta interfaz cuando se usan DesignerTransaction objetos para proporcionar funcionalidad de deshacer y rehacer para acciones en tiempo de diseño que afectan a los componentes. Puede encontrar más información en la documentación de DesignerTransaction. Por lo general, solo el diseñador raíz controla estas notificaciones de cambio.

Este servicio también proporciona métodos que generan un evento de cambio de componente o un evento de cambio de componente. Un PropertyDescriptor componente o puede indicar que un componente ha cambiado o está cambiando con los OnComponentChanged métodos y OnComponentChanging , respectivamente.

Métodos

OnComponentChanged(Object, MemberDescriptor, Object, Object)	Anuncia al servicio de cambio de componentes que un determinado componente ha cambiado.
OnComponentChanging(Object, MemberDescriptor)	Anuncia al servicio de cambio de componentes que un determinado componente está cambiando.

Eventos

ComponentAdded	Se produce cuando se ha agregado un componente.
ComponentAdding	Se produce cuando un componente está en el proceso de agregarse.
ComponentChanged	Se produce cuando se ha cambiado un componente.
ComponentChanging	Se produce cuando un componente está en el proceso de cambiarse.
ComponentRemoved	Se produce cuando se ha quitado un componente.
ComponentRemoving	Se produce cuando un componente está en el proceso de quitarse.
ComponentRename	Se produce cuando se cambia el nombre de un componente.

Se aplica a

Consulte también

• ComponentEventHandler
• ComponentChangedEventHandler
• ComponentChangingEventHandler
• ComponentRenameEventHandler
• MemberDescriptor
• DesignerTransaction