IComponentChangeService Interface

Définition

Espace de noms:

System.ComponentModel.Design

Assembly:

System.ComponentModel.TypeConverter.dll

Fournit une interface permettant d'ajouter et de supprimer les gestionnaires d'événements pour les événements qui ajoutent, modifient, suppriment ou renomment des composants, et fournit des méthodes pour déclencher un événement ComponentChanged ou ComponentChanging.

C#

public interface IComponentChangeService

Exemples

Cet exemple montre comment utiliser l’interface IComponentChangeService pour recevoir des notifications sur l’ajout, la suppression et les modifications apportées à des composants en mode création.

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 );
    }
    }
}

Remarques

IComponentChangeService fournit une interface qui peut être utilisée pour indiquer les méthodes qui gèrent les événements suivants :

• ComponentAdded, déclenché lorsqu’un composant est ajouté.

• ComponentAdding, déclenché lorsqu’un composant est sur le point d’être ajouté.

• ComponentChanged, déclenché lorsqu’un composant est modifié.

• ComponentChanging, déclenché lorsqu’un composant est sur le point d’être modifié.

• ComponentRemoved, déclenché lorsqu’un composant est supprimé.

• ComponentRemoving, déclenché lorsqu’un composant est sur le point d’être supprimé.

• ComponentRename, déclenché lorsqu’un composant est renommé.

En règle générale, l’environnement de conception déclenche ces événements d’ajout, de modification, de suppression ou de renommage de ces composants. Les concepteurs doivent appeler les méthodes de cette interface lors de l’utilisation DesignerTransaction d’objets pour fournir des fonctionnalités d’annulation et de rétablissement pour les actions au moment du design qui affectent les composants. Pour plus d’informations, consultez la documentation relative à DesignerTransaction. En règle générale, seul le concepteur racine gère ces notifications de modification.

Ce service fournit également des méthodes qui déclenchent un événement de modification de composant ou un événement de modification de composant. Un PropertyDescriptor ou un composant peut indiquer qu’un composant a changé ou est en cours de modification avec les OnComponentChanged méthodes et OnComponentChanging , respectivement.

Méthodes

OnComponentChanged(Object, MemberDescriptor, Object, Object)	Avertit le service de modification du composant qu'un composant particulier a été modifié.
OnComponentChanging(Object, MemberDescriptor)	Avertit le service de modification du composant qu'un composant particulier est en cours de modification.

Événements

ComponentAdded	Se produit suite à l'ajout d'un composant.
ComponentAdding	Se produit pendant le processus d'ajout d'un composant.
ComponentChanged	Se produit suite à la modification d'un composant.
ComponentChanging	Se produit pendant le processus de modification d'un composant.
ComponentRemoved	Se produit suite à la suppression d'un composant.
ComponentRemoving	Se produit pendant le processus de suppression d'un composant.
ComponentRename	Se produit lorsqu'un composant est renommé.

S’applique à

Voir aussi

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