IDesignerHost Interfejs

Definicja

Przestrzeń nazw:

System.ComponentModel.Design

Zestaw:

System.ComponentModel.TypeConverter.dll

Udostępnia interfejs do zarządzania transakcjami i składnikami projektanta.

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

Pochodne

System.ComponentModel.Design.Serialization.IDesignerLoaderHost

System.ComponentModel.Design.Serialization.IDesignerLoaderHost2

Implementuje

IServiceContainer IServiceProvider

Przykłady

Poniższy przykładowy kod pokazuje, jak uzyskać IDesignerHost interfejs usługi z projektanta lub składnika lokacji.

// 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)

Poniższy przykładowy kod przedstawia użycie interfejsu do wyświetlania IDesignerHost listy składników projektu.

#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

Uwagi

IDesignerHostto interfejs, który współpracuje z architekturą projektanta formularzy .NET Framework w celu zapewnienia obsługi zarządzania transakcjami i składnikami projektanta.

.NET Framework nie zapewnia implementacji tego interfejsu. Interfejs jest implementowany przez narzędzia programistyczne, które obsługują projektantów.

Uwagi dotyczące wywoływania

Aby uzyskać implementację z IDesignerHost poziomu środowiska deweloperskiego, wywołaj metodę GetService(Type) , gdy składnik jest aktywny w trybie projektowania, przekazując typ IDesignerHost żądania interfejsu IDesignerHost usługi.

IDesignerHost udostępnia następujące elementy członkowskie związane ze stanem projektanta:

• Właściwość Loading wskazuje, czy jest ładowany projektant, czy dokument.

• Zdarzenie Activated występuje, gdy projektant jest aktywowany przed wyświetleniem.

• Zdarzenie Deactivated występuje, gdy projektant jest dezaktywowany.

• Zdarzenie LoadComplete występuje po załadowaniu dokumentu.

• Metoda Activate() aktywuje projektanta.

IDesignerHost udostępnia następujące elementy członkowskie związane z zarządzaniem składnikami:

• Właściwość Container wskazuje kontener hosta projektanta.

• Właściwość RootComponent wskazuje klasę bazową składnika głównego.

• Właściwość RootComponentClassName wskazuje nazwę klasy składnika głównego.

• Metoda CreateComponent(Type) tworzy określony typ składnika.

• Metoda DestroyComponent(IComponent) niszczy określony składnik.

• Metoda GetDesigner(IComponent) pobiera projektanta skojarzonego z określonym składnikiem.

• Metoda GetType(String) pobiera wystąpienie typu o określonej nazwie.

IDesignerHost udostępnia następujące elementy członkowskie związane z zarządzaniem transakcjami:

• Właściwość InTransaction wskazuje, czy projektant jest w transakcji.

• Właściwość TransactionDescription wskazuje bieżący opis transakcji.

• Zdarzenie TransactionClosed występuje po zakończeniu transakcji.

• Zdarzenie występuje, gdy transakcja TransactionClosing ma zostać zakończona.

• Zdarzenie TransactionOpened występuje po rozpoczęciu transakcji.

• Zdarzenie występuje, gdy transakcja TransactionOpening ma się rozpocząć.

• Metoda CreateTransaction() tworzy i zwraca nową transakcję.

Właściwości

Container	Pobiera kontener dla tego hosta projektanta.
InTransaction	Pobiera wartość wskazującą, czy host projektanta jest obecnie w transakcji.
Loading	Pobiera wartość wskazującą, czy host projektanta aktualnie ładuje dokument.
RootComponent	Pobiera wystąpienie klasy bazowej używane jako składnik główny bieżącego projektu.
RootComponentClassName	Pobiera w pełni kwalifikowaną nazwę klasy, która jest projektowana.
TransactionDescription	Pobiera opis bieżącej transakcji.

Metody

Activate()	Aktywuje projektanta, który host jest hostem.
AddService(Type, Object)	Dodaje określoną usługę do kontenera usługi. (Odziedziczone po IServiceContainer)
AddService(Type, Object, Boolean)	Dodaje określoną usługę do kontenera usługi i opcjonalnie promuje usługę do dowolnych kontenerów usługi nadrzędnej. (Odziedziczone po IServiceContainer)
AddService(Type, ServiceCreatorCallback)	Dodaje określoną usługę do kontenera usługi. (Odziedziczone po IServiceContainer)
AddService(Type, ServiceCreatorCallback, Boolean)	Dodaje określoną usługę do kontenera usługi i opcjonalnie promuje usługę do kontenerów usługi nadrzędnej. (Odziedziczone po IServiceContainer)
CreateComponent(Type)	Tworzy składnik określonego typu i dodaje go do dokumentu projektowego.
CreateComponent(Type, String)	Tworzy składnik określonego typu i nazwy oraz dodaje go do dokumentu projektowego.
CreateTransaction()	Tworzy element DesignerTransaction , który może hermetyzować sekwencje zdarzeń w celu zwiększenia wydajności i włączenia funkcji cofania i ponownego obsługi.
CreateTransaction(String)	Tworzy element DesignerTransaction , który może hermetyzować sekwencje zdarzeń w celu zwiększenia wydajności i włączenia funkcji cofania i ponownego obsługi przy użyciu określonego opisu transakcji.
DestroyComponent(IComponent)	Niszczy określony składnik i usuwa go z kontenera projektanta.
GetDesigner(IComponent)	Pobiera wystąpienie projektanta zawierające określony składnik.
GetService(Type)	Pobiera obiekt usługi określonego typu. (Odziedziczone po IServiceProvider)
GetType(String)	Pobiera wystąpienie określonej, w pełni kwalifikowanej nazwy typu.
RemoveService(Type)	Usuwa określony typ usługi z kontenera usługi. (Odziedziczone po IServiceContainer)
RemoveService(Type, Boolean)	Usuwa określony typ usługi z kontenera usługi i opcjonalnie promuje usługę do kontenerów usługi nadrzędnej. (Odziedziczone po IServiceContainer)

Zdarzenia

Activated	Występuje po aktywowaniu tego projektanta.
Deactivated	Występuje, gdy ten projektant jest dezaktywowany.
LoadComplete	Występuje po zakończeniu ładowania dokumentu przez tego projektanta.
TransactionClosed	Dodaje procedurę obsługi zdarzeń TransactionClosed dla zdarzenia.
TransactionClosing	Dodaje procedurę obsługi zdarzeń TransactionClosing dla zdarzenia.
TransactionOpened	Dodaje procedurę obsługi zdarzeń TransactionOpened dla zdarzenia.
TransactionOpening	Dodaje procedurę obsługi zdarzeń TransactionOpening dla zdarzenia.

Metody rozszerzania

GetKeyedService<T>(IServiceProvider, Object)	Pobiera usługę typu T z elementu IServiceProvider.
GetKeyedServices(IServiceProvider, Type, Object)	Pobiera wyliczenie usług typu serviceType z klasy IServiceProvider.
GetKeyedServices<T>(IServiceProvider, Object)	Pobiera wyliczenie usług typu T z klasy IServiceProvider.
GetRequiredKeyedService(IServiceProvider, Type, Object)	Pobiera usługę typu serviceType z elementu IServiceProvider.
GetRequiredKeyedService<T>(IServiceProvider, Object)	Pobiera usługę typu T z elementu IServiceProvider.
CreateAsyncScope(IServiceProvider)	Tworzy nową AsyncServiceScope , która może służyć do rozwiązywania problemów z usługami o określonym zakresie.
CreateScope(IServiceProvider)	Tworzy nową IServiceScope , która może służyć do rozwiązywania problemów z usługami o określonym zakresie.
GetRequiredService(IServiceProvider, Type)	Pobierz usługę typu serviceType z elementu IServiceProvider.
GetRequiredService<T>(IServiceProvider)	Pobierz usługę typu T z elementu IServiceProvider.
GetService<T>(IServiceProvider)	Pobierz usługę typu T z elementu IServiceProvider.
GetServices(IServiceProvider, Type)	Pobierz wyliczenie usług typu serviceType z klasy IServiceProvider.
GetServices<T>(IServiceProvider)	Pobierz wyliczenie usług typu T z klasy IServiceProvider.
GetFakeLogCollector(IServiceProvider)	Pobiera obiekt zbierający rekordy dziennika wysyłane do fałszywego rejestratora.
GetFakeRedactionCollector(IServiceProvider)	Pobiera fałszywe wystąpienie modułu zbierającego redactor z kontenera wstrzykiwania zależności.

Zobacz też

• IDesigner
• IDesignerEventService
• IDesignerOptionService