IDesignerHost Interface

Définition

Espace de noms:

System.ComponentModel.Design

Assembly:

System.ComponentModel.TypeConverter.dll

Fournit une interface pour la gestion des transactions et composants du concepteur.

public interface class IDesignerHost : IServiceProvider, System::ComponentModel::Design::IServiceContainer

public interface IDesignerHost : IServiceProvider, System.ComponentModel.Design.IServiceContainer

type IDesignerHost = interface
    interface IServiceContainer
    interface IServiceProvider

Public Interface IDesignerHost
Implements IServiceContainer, IServiceProvider

Dérivé

System.ComponentModel.Design.Serialization.IDesignerLoaderHost

System.ComponentModel.Design.Serialization.IDesignerLoaderHost2

Implémente

IServiceContainer IServiceProvider

Exemples

L’exemple de code suivant montre comment obtenir l’interface IDesignerHost de service à partir d’un concepteur ou d’un composant site.

// Requests an IDesignerHost service from the design time environment using Component.Site.GetService()
IDesignerHost^ dh = static_cast<IDesignerHost^>(this->Component->Site->GetService( IDesignerHost::typeid ));

// Requests an IDesignerHost service from the design time environment using Component.Site.GetService()
IDesignerHost dh = (IDesignerHost) this.Component.Site.GetService(typeof(IDesignerHost));

' Requests an IDesignerHost service from the design time environment using Component.Site.GetService()
Dim host As IDesignerHost = CType(Me.Component.Site.GetService(GetType(IDesignerHost)), IDesignerHost)

L’exemple de code suivant illustre l’utilisation de l’interface IDesignerHost pour répertorier les composants du projet.

#using <System.Windows.Forms.dll>
#using <System.Drawing.dll>
#using <System.dll>

using namespace System;
using namespace System::ComponentModel;
using namespace System::ComponentModel::Design;
using namespace System::Drawing;
using namespace System::Windows::Forms;
using namespace System::Security::Permissions;

// Provides a form containing a listbox that can display 
// a list of project components.
public ref class DesignerHostListForm: public System::Windows::Forms::Form
{
public:
   System::Windows::Forms::ListBox^ listBox1;

private:
   System::Windows::Forms::Button^ ok_button;

public:
   DesignerHostListForm()
   {
      this->Name = "DesignerHostListForm";
      this->Text = "List of design-time project components";
      this->SuspendLayout();
      this->listBox1 = gcnew System::Windows::Forms::ListBox;
      this->listBox1->Location = System::Drawing::Point( 8, 8 );
      this->listBox1->Name = "listBox1";
      this->listBox1->Size = System::Drawing::Size( 385, 238 );
      this->listBox1->TabIndex = 0;
      this->listBox1->Anchor = static_cast<AnchorStyles>(((System::Windows::Forms::AnchorStyles::Top | System::Windows::Forms::AnchorStyles::Bottom) | System::Windows::Forms::AnchorStyles::Left) | System::Windows::Forms::AnchorStyles::Right);
      this->ok_button = gcnew System::Windows::Forms::Button;
      this->ok_button->DialogResult = System::Windows::Forms::DialogResult::OK;
      this->ok_button->Location = System::Drawing::Point( 232, 256 );
      this->ok_button->Name = "ok_button";
      this->ok_button->TabIndex = 1;
      this->ok_button->Text = "OK";
      this->ok_button->Anchor = static_cast<AnchorStyles>(System::Windows::Forms::AnchorStyles::Bottom | System::Windows::Forms::AnchorStyles::Right);
      this->ClientSize = System::Drawing::Size( 400, 285 );
      array<System::Windows::Forms::Control^>^temp2 = {this->ok_button,this->listBox1};
      this->Controls->AddRange( temp2 );
      this->ResumeLayout( false );
   }

public:
   ~DesignerHostListForm()
   {
   }
};


// You can double-click the component of an IDesignerHostExampleDesigner 
// to show a form containing a listbox that lists the name and type 
// of each component or control in the current design-time project.
public ref class IDesignerHostExampleDesigner: public IDesigner
{
private:
   System::ComponentModel::IComponent^ component;

public:
   IDesignerHostExampleDesigner(){}

   virtual void DoDefaultAction()
   {
      ListComponents();
   }

   virtual void Initialize( System::ComponentModel::IComponent^ component )
   {
      this->component = component;
      MessageBox::Show( "Double-click the IDesignerHostExample component to view a list of project components." );
   }


private:

   // Displays a list of components in the current design 
   // document when the default action of the designer is invoked.
   void ListComponents()
   {
      DesignerHostListForm^ listform = gcnew DesignerHostListForm;

      // Obtain an IDesignerHost service from the design environment.
      IDesignerHost^ host = dynamic_cast<IDesignerHost^>(this->component->Site->GetService( IDesignerHost::typeid ));

      // Get the project components container (control containment depends on Controls collections)
      IContainer^ container = host->Container;

      // Add each component's type name and name to the list box.
      System::Collections::IEnumerator^ myEnum = container->Components->GetEnumerator();
      while ( myEnum->MoveNext() )
      {
         IComponent^ component = safe_cast<IComponent^>(myEnum->Current);
         listform->listBox1->Items->Add( String::Concat( component->GetType()->Name, " : ", component->Site->Name ) );
      }

      listform->ShowDialog();
   }

public:

   property System::ComponentModel::IComponent^ Component 
   {
      virtual System::ComponentModel::IComponent^ get()
      {
         return this->component;
      }
   }

   property System::ComponentModel::Design::DesignerVerbCollection^ Verbs 
   {
      [PermissionSetAttribute(SecurityAction::Demand, Name="FullTrust")]
      virtual System::ComponentModel::Design::DesignerVerbCollection^ get()
      {
         DesignerVerbCollection^ dvc = gcnew DesignerVerbCollection;
         dvc->Add( gcnew DesignerVerb( "List Components",gcnew EventHandler( this, &IDesignerHostExampleDesigner::ListHandler ) ) );
         return dvc;
      }
   }

private:
   void ListHandler( Object^ /*sender*/, EventArgs^ /*e*/ )
   {
      ListComponents();
   }

public:
   ~IDesignerHostExampleDesigner(){}
};


// IDesignerHostExampleComponent is a component associated 
// with the IDesignerHostExampleDesigner that demonstrates 
// acquisition and use of the IDesignerHost service 
// to list project components.

[DesignerAttribute(IDesignerHostExampleDesigner::typeid)]
public ref class IDesignerHostExampleComponent: public System::ComponentModel::Component
{
public:
   IDesignerHostExampleComponent(){}

public:
   ~IDesignerHostExampleComponent(){}
};

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

namespace IDesignerHostExample
{	
    // IDesignerHostExampleComponent is a component associated 
    // with the IDesignerHostExampleDesigner that demonstrates 
    // acquisition and use of the IDesignerHost service 
    // to list project components.
    [DesignerAttribute(typeof(IDesignerHostExampleDesigner))]
    public class IDesignerHostExampleComponent : System.ComponentModel.Component
    {
        public IDesignerHostExampleComponent()
        {}

        protected override void Dispose( bool disposing )
        {
            base.Dispose( disposing );
        }
    }

    // You can double-click the component of an IDesignerHostExampleDesigner 
    // to show a form containing a listbox that lists the name and type 
    // of each component or control in the current design-time project.
    public class IDesignerHostExampleDesigner : IDesigner
    {
        private System.ComponentModel.IComponent component;

        public IDesignerHostExampleDesigner()
        {}

        public void DoDefaultAction()
        {
            ListComponents();
        }

        public void Initialize(System.ComponentModel.IComponent component)
        {
            this.component = component;
            MessageBox.Show("Double-click the IDesignerHostExample component to view a list of project components.");
        }

        // Displays a list of components in the current design 
        // document when the default action of the designer is invoked.
        private void ListComponents()
        {
            using (DesignerHostListForm listform = new DesignerHostListForm())
            {
                // Obtain an IDesignerHost service from the design environment.
                IDesignerHost host = (IDesignerHost)this.component.Site.GetService(typeof(IDesignerHost));
                // Get the project components container (control containment depends on Controls collections)
                IContainer container = host.Container;
                // Add each component's type name and name to the list box.
                foreach (IComponent component in container.Components)
                {
                    listform.listBox1.Items.Add(component.GetType().Name + " : " + component.Site.Name);
                }
                // Display the form.
                listform.ShowDialog();
            }
        }

        public System.ComponentModel.IComponent Component
        {
            get
            {
                return this.component;
            }
        }

        public System.ComponentModel.Design.DesignerVerbCollection Verbs
        {
            get
            {
                DesignerVerbCollection dvc = new DesignerVerbCollection();
                dvc.Add( new DesignerVerb("List Components", new EventHandler(ListHandler)) );
                return dvc;
            }
        }

        private void ListHandler(object sender, EventArgs e)
        {
            ListComponents();
        }

        public void Dispose() {	}
    }

    // Provides a form containing a listbox that can display 
    // a list of project components.
    public class DesignerHostListForm : System.Windows.Forms.Form
    {
        public System.Windows.Forms.ListBox listBox1;
        private System.Windows.Forms.Button ok_button;
        
        public DesignerHostListForm()
        {
            this.Name = "DesignerHostListForm";
            this.Text = "List of design-time project components";
            this.SuspendLayout();
            this.listBox1 = new System.Windows.Forms.ListBox();						
            this.listBox1.Location = new System.Drawing.Point(8, 8);
            this.listBox1.Name = "listBox1";
            this.listBox1.Size = new System.Drawing.Size(385, 238);
            this.listBox1.TabIndex = 0;	
            this.listBox1.Anchor = (((System.Windows.Forms.AnchorStyles.Top | System.Windows.Forms.AnchorStyles.Bottom) 
                | System.Windows.Forms.AnchorStyles.Left) 
                | System.Windows.Forms.AnchorStyles.Right);		
            this.ok_button = new System.Windows.Forms.Button();
            this.ok_button.DialogResult = System.Windows.Forms.DialogResult.OK;
            this.ok_button.Location = new System.Drawing.Point(232, 256);
            this.ok_button.Name = "ok_button";
            this.ok_button.TabIndex = 1;
            this.ok_button.Text = "OK";
            this.ok_button.Anchor = (System.Windows.Forms.AnchorStyles.Bottom | System.Windows.Forms.AnchorStyles.Right);
            this.ClientSize = new System.Drawing.Size(400, 285);
            this.Controls.AddRange(new System.Windows.Forms.Control[] { this.ok_button, this.listBox1 });
            this.ResumeLayout(false);	
        }

        protected override void Dispose( bool disposing )
        {			
            base.Dispose( disposing );
        }	
    }
}

Imports System.ComponentModel
Imports System.ComponentModel.Design
Imports System.Drawing
Imports System.Windows.Forms

Namespace IDesignerHostExample
   
   ' IDesignerHostExampleComponent is a component associated 
   ' with the IDesignerHostExampleDesigner that demonstrates 
   ' acquisition and use of the IDesignerHost service 
   ' to list project components.
    <DesignerAttribute(GetType(IDesignerHostExampleDesigner))> _
    Public Class IDesignerHostExampleComponent
        Inherits System.ComponentModel.Component

        Public Sub New()
        End Sub

        Protected Overloads Sub Dispose(ByVal disposing As Boolean)
            MyBase.Dispose(disposing)
        End Sub 
    End Class 

    ' You can double-click the component of a IDesignerHostExampleDesigner
    ' to show a form containing a listbox that lists the name and type 
    ' of each component or control in the current design-time project.
    <System.Security.Permissions.PermissionSetAttribute(System.Security.Permissions.SecurityAction.Demand, Name:="FullTrust")> _
    Public Class IDesignerHostExampleDesigner
        Implements IDesigner
        Private component_ As System.ComponentModel.IComponent

        Public Sub New()
        End Sub

        Public Sub DoDefaultAction() Implements IDesigner.DoDefaultAction
            ListComponents()
        End Sub

        Public Sub Initialize(ByVal component As System.ComponentModel.IComponent) Implements IDesigner.Initialize
            Me.component_ = component
            MessageBox.Show("Double-click the IDesignerHostExample component to view a list of project components.")
        End Sub

        ' Displays a list of components in the current design 
        ' document when the default action of the designer is invoked.
        Private Sub ListComponents()

            Using listform As New DesignerHostListForm()

                ' Obtain an IDesignerHost service from the design environment.
                Dim host As IDesignerHost = CType(Me.Component.Site.GetService(GetType(IDesignerHost)), IDesignerHost)
                ' Get the project components container (control containment depends on Controls collections)
                Dim container As IContainer = host.Container
                ' Add each component's type name and name to the list box.
                Dim comp As Component
                For Each comp In container.Components
                    listform.listBox1.Items.Add((comp.GetType().Name + " : " + Component.Site.Name))
                Next comp
                ' Display the form.
                listform.ShowDialog()

            End Using

        End Sub

        Public ReadOnly Property Component() As System.ComponentModel.IComponent Implements IDesigner.Component
            Get
                Return component_
            End Get
        End Property

        Public ReadOnly Property Verbs() As System.ComponentModel.Design.DesignerVerbCollection Implements IDesigner.Verbs
            Get
                Dim dvc As New DesignerVerbCollection()
                dvc.Add(New DesignerVerb("List Components", New EventHandler(AddressOf ListHandler)))
                Return dvc
            End Get
        End Property

        Private Sub ListHandler(ByVal sender As Object, ByVal e As EventArgs)
            ListComponents()
        End Sub

        Public Sub Dispose() Implements IDisposable.Dispose
        End Sub
    End Class
    _ 

    ' Provides a form containing a list box that can display 
    ' a list of project components.
    Public Class DesignerHostListForm
        Inherits System.Windows.Forms.Form
        Public listBox1 As System.Windows.Forms.ListBox
        Private ok_button As System.Windows.Forms.Button

        Public Sub New()
            Me.Name = "DesignerHostListForm"
            Me.Text = "List of design-time project components"
            Me.SuspendLayout()
            Me.listBox1 = New System.Windows.Forms.ListBox()
            Me.listBox1.Location = New System.Drawing.Point(8, 8)
            Me.listBox1.Name = "listBox1"
            Me.listBox1.Size = New System.Drawing.Size(385, 238)
            Me.listBox1.TabIndex = 0
            Me.listBox1.Anchor = (((System.Windows.Forms.AnchorStyles.Top Or System.Windows.Forms.AnchorStyles.Bottom) _
            Or System.Windows.Forms.AnchorStyles.Left) Or System.Windows.Forms.AnchorStyles.Right)
            Me.ok_button = New System.Windows.Forms.Button()
            Me.ok_button.DialogResult = System.Windows.Forms.DialogResult.OK
            Me.ok_button.Location = New System.Drawing.Point(232, 256)
            Me.ok_button.Name = "ok_button"
            Me.ok_button.TabIndex = 1
            Me.ok_button.Text = "OK"
            Me.ok_button.Anchor = (System.Windows.Forms.AnchorStyles.Bottom Or System.Windows.Forms.AnchorStyles.Right)
            Me.ClientSize = New System.Drawing.Size(400, 285)
            Me.Controls.AddRange(New System.Windows.Forms.Control() {Me.ok_button, Me.listBox1})
            Me.ResumeLayout(False)
        End Sub 

        Protected Overloads Sub Dispose(ByVal disposing As Boolean)
            MyBase.Dispose(disposing)
        End Sub 
    End Class 
End Namespace

Remarques

IDesignerHost est une interface qui fonctionne avec l’architecture du concepteur de formulaires .NET Framework pour assurer la prise en charge de la gestion des transactions et des composants du concepteur.

Le .NET Framework ne fournit pas d’implémentation de cette interface. L’interface est implémentée par les outils de développement qui prennent en charge les concepteurs.

Notes pour les appelants

Pour obtenir une implémentation de à partir d’un environnement de IDesignerHost développement, appelez GetService(Type) pendant que votre composant est actif en mode création, en passant le type de pour demander une IDesignerHost interface de IDesignerHost service.

IDesignerHost fournit les membres suivants liés à l’état du concepteur :

• La Loading propriété indique si un concepteur ou un document est en cours de chargement.

• L’événement Activated se produit lorsqu’un concepteur est activé avant l’affichage.

• L’événement Deactivated se produit lorsqu’un concepteur est désactivé.

• L’événement LoadComplete se produit après le chargement d’un document.

• La Activate() méthode active le concepteur.

IDesignerHost fournit les membres suivants liés à la gestion des composants :

• La Container propriété indique le conteneur de l’hôte du concepteur.

• La RootComponent propriété indique la classe de base pour le composant racine.

• La RootComponentClassName propriété indique le nom de la classe du composant racine.

• La CreateComponent(Type) méthode crée le type de composant spécifié.

• La DestroyComponent(IComponent) méthode détruit le composant spécifié.

• La GetDesigner(IComponent) méthode obtient le concepteur associé à un composant spécifié.

• La GetType(String) méthode obtient une instance du type avec le nom spécifié.

IDesignerHost fournit les membres suivants liés à la gestion des transactions :

• La InTransaction propriété indique si le concepteur se trouve dans une transaction.

• La TransactionDescription propriété indique la description de la transaction actuelle.

• L’événement TransactionClosed se produit lorsqu’une transaction a été effectuée.

• L’événement TransactionClosing se produit lorsqu’une transaction est sur le point d’être terminée.

• L’événement TransactionOpened se produit lorsqu’une transaction a commencé.

• L’événement TransactionOpening se produit lorsqu’une transaction est sur le point de commencer.

• La CreateTransaction() méthode crée et retourne une nouvelle transaction.

Propriétés

Container	Obtient le conteneur de cet hôte de concepteur.
InTransaction	Obtient une valeur indiquant si l'hôte du concepteur se trouve actuellement dans une transaction.
Loading	Obtient une valeur indiquant si l'hôte du concepteur charge actuellement le document.
RootComponent	Obtient l'instance de la classe de base utilisée comme composant racine pour le design en cours.
RootComponentClassName	Obtient le nom qualifié complet de la classe dont le design est en cours.
TransactionDescription	Obtient la description de la transaction en cours.

Méthodes

Activate()	Active le concepteur hébergé par cet hôte.
AddService(Type, Object)	Ajoute le service spécifié au conteneur de service. (Hérité de IServiceContainer)
AddService(Type, Object, Boolean)	Ajoute le service spécifié au conteneur de services et promeut éventuellement le service vers les conteneurs de services parents éventuels. (Hérité de IServiceContainer)
AddService(Type, ServiceCreatorCallback)	Ajoute le service spécifié au conteneur de service. (Hérité de IServiceContainer)
AddService(Type, ServiceCreatorCallback, Boolean)	Ajoute le service spécifié au conteneur de service, et promeut éventuellement le service au niveau de n'importe quel conteneur de service parent. (Hérité de IServiceContainer)
CreateComponent(Type)	Crée un composant du type spécifié et l'ajoute au document de design.
CreateComponent(Type, String)	Crée un composant du type spécifié avec le nom donné et l'ajoute au document de design.
CreateTransaction()	Crée un DesignerTransaction pouvant encapsuler des séquences d'événements afin d'améliorer les performances et de permettre l'annulation, ainsi que le rétablissement des fonctionnalités de prise en charge.
CreateTransaction(String)	Crée un DesignerTransaction pouvant encapsuler des séquences d'événements afin d'améliorer les performances et de permettre l'annulation, ainsi que le rétablissement des fonctionnalités de prise en charge, à l'aide de la description de la transaction spécifiée.
DestroyComponent(IComponent)	Détruit le composant spécifié et le supprime du conteneur du concepteur.
GetDesigner(IComponent)	Obtient l'instance de concepteur qui contient le composant spécifié.
GetService(Type)	Obtient l'objet service du type spécifié. (Hérité de IServiceProvider)
GetType(String)	Obtient une instance du nom de type qualifié complet spécifié.
RemoveService(Type)	Supprime le type de service spécifié du conteneur de service. (Hérité de IServiceContainer)
RemoveService(Type, Boolean)	Supprime le type de service spécifié du conteneur de service, et promeut éventuellement le service au niveau de n'importe quel conteneur de service parent. (Hérité de IServiceContainer)

Événements

Activated	Se produit lorsque ce concepteur est activé.
Deactivated	Se produit lorsque ce concepteur est désactivé.
LoadComplete	Se produit lorsque ce concepteur a terminé le chargement de son document.
TransactionClosed	Ajoute un gestionnaire d'événements pour l'événement TransactionClosed.
TransactionClosing	Ajoute un gestionnaire d'événements pour l'événement TransactionClosing.
TransactionOpened	Ajoute un gestionnaire d'événements pour l'événement TransactionOpened.
TransactionOpening	Ajoute un gestionnaire d'événements pour l'événement TransactionOpening.

Méthodes d’extension

GetKeyedService<T>(IServiceProvider, Object)	Obtient un service de type T à partir de .IServiceProvider
GetKeyedServices(IServiceProvider, Type, Object)	Obtient une énumération des services de type serviceType à partir de IServiceProvider.
GetKeyedServices<T>(IServiceProvider, Object)	Obtient une énumération des services de type T à partir de IServiceProvider.
GetRequiredKeyedService(IServiceProvider, Type, Object)	Obtient un service de type serviceType à partir de .IServiceProvider
GetRequiredKeyedService<T>(IServiceProvider, Object)	Obtient un service de type T à partir de .IServiceProvider
CreateAsyncScope(IServiceProvider)	Crée un AsyncServiceScope qui peut être utilisé pour résoudre des services délimités.
CreateScope(IServiceProvider)	Crée un IServiceScope qui peut être utilisé pour résoudre des services délimités.
GetRequiredService(IServiceProvider, Type)	Obtient le service de type serviceType à partir du IServiceProvider.
GetRequiredService<T>(IServiceProvider)	Obtient le service de type T à partir du IServiceProvider.
GetService<T>(IServiceProvider)	Obtient le service de type T à partir du IServiceProvider.
GetServices(IServiceProvider, Type)	Obtient une énumération des services de type serviceType à partir du IServiceProvider.
GetServices<T>(IServiceProvider)	Obtient une énumération des services de type T à partir du IServiceProvider.
GetFakeLogCollector(IServiceProvider)	Obtient l’objet qui collecte les enregistrements de journal envoyés au faux journal.
GetFakeRedactionCollector(IServiceProvider)	Obtient le faux collecteur de redacteur instance à partir du conteneur d’injection de dépendances.

Voir aussi

• IDesigner
• IDesignerEventService
• IDesignerOptionService