IDesignerHost Интерфейс

Определение

Предоставляет интерфейс для управления транзакциями и компонентами конструктора.Provides an interface for managing designer transactions and components.

public interface class IDesignerHost : IServiceProvider, System::ComponentModel::Design::IServiceContainer
[System.Runtime.InteropServices.ComVisible(true)]
public interface IDesignerHost : IServiceProvider, System.ComponentModel.Design.IServiceContainer
type IDesignerHost = interface
    interface IServiceContainer
    interface IServiceProvider
Public Interface IDesignerHost
Implements IServiceContainer, IServiceProvider
Производный
Атрибуты
Реализации

Примеры

В следующем примере кода показано, как получить IDesignerHost интерфейс службы из конструктора или с помощью веб-компонента.The following example code demonstrates how to obtain the IDesignerHost service interface from a designer or sited component.

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

В следующем примере кода демонстрируется использование IDesignerHost интерфейса для перечисления компонентов проекта.The following example code demonstrates using the IDesignerHost interface to list project components.

#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.
    [System.Security.Permissions.PermissionSet(System.Security.Permissions.SecurityAction.Demand, Name = "FullTrust")] 
    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 

Комментарии

IDesignerHost— Это интерфейс, который работает с архитектурой конструктора форм .NET Framework Forms для обеспечения поддержки управления транзакциями и компонентами конструктора.IDesignerHost is an interface that works with the .NET Framework forms designer architecture to provide support for designer transaction and component management.

.NET Framework не предоставляет реализацию этого интерфейса.The .NET Framework does not provide an implementation of this interface. Интерфейс реализуется средствами разработки, которые поддерживают конструкторы.The interface is implemented by development tools that support designers.

Примечания для тех, кто вызывает этот метод

Чтобы получить реализацию IDesignerHost из среды разработки, вызовите GetService(Type) , пока компонент активен в режиме конструктора IDesignerHost , передав IDesignerHost тип для запроса интерфейса службы.To obtain an implementation of IDesignerHost from a development environment, call GetService(Type) while your component is active in design mode, passing the type of IDesignerHost to request an IDesignerHost service interface.

IDesignerHostпредоставляет следующие члены, связанные с состоянием конструктора:IDesignerHost provides the following members related to designer state: Loading — Свойство указывает, загружен ли конструктор или документ.- The Loading property indicates whether a designer or document is being loaded.

— Это Activated событие возникает при активации конструктора перед отображением.- The Activated event occurs when a designer is activated before display.

Deactivated — Событие возникает при отключении конструктора.- The Deactivated event occurs when a designer is deactivated.

LoadComplete — Событие возникает после загрузки документа.- The LoadComplete event occurs after a document is loaded.

Activate() — Метод активирует конструктор.- The Activate() method activates the designer.

IDesignerHostпредоставляет следующие элементы, связанные с управлением компонентами:IDesignerHost provides the following members related to managing components: Container — Свойство указывает контейнер для узла конструктора.- The Container property indicates the container for the designer host.

RootComponent — Свойство указывает базовый класс для корневого компонента.- The RootComponent property indicates the base class for the root component.

RootComponentClassName — Свойство указывает имя класса корневого компонента.- The RootComponentClassName property indicates the name of the class of the root component.

CreateComponent(Type) — Метод создает указанный тип компонента.- The CreateComponent(Type) method creates the specified type of component.

DestroyComponent(IComponent) — Метод уничтожает указанный компонент.- The DestroyComponent(IComponent) method destroys the specified component.

GetDesigner(IComponent) — Метод получает конструктор, связанный с указанным компонентом.- The GetDesigner(IComponent) method gets the designer associated with a specified component.

GetType(String) — Метод получает экземпляр типа с указанным именем.- The GetType(String) method gets an instance of the type with the specified name.

IDesignerHostпредоставляет следующие элементы, связанные с управлением транзакциями:IDesignerHost provides the following members related to managing transactions: InTransaction — Свойство указывает, находится ли конструктор в транзакции.- The InTransaction property indicates whether the designer is in a transaction.

TransactionDescription — Свойство указывает текущее описание транзакции.- The TransactionDescription property indicates the current transaction description.

TransactionClosed — Событие возникает при завершении транзакции.- The TransactionClosed event occurs when a transaction has been completed.

TransactionClosing — Событие возникает при завершении транзакции.- The TransactionClosing event occurs when a transaction is about to be completed.

TransactionOpened — Событие возникает при начале транзакции.- The TransactionOpened event occurs when a transaction has begun.

TransactionOpening — Событие возникает при начале транзакции.- The TransactionOpening event occurs when a transaction is about to begin.

CreateTransaction() — Метод создает и возвращает новую транзакцию.- The CreateTransaction() method creates and returns a new transaction.

Свойства

Container

Получает контейнер для данного хоста конструктора.Gets the container for this designer host.

InTransaction

Получает значение, показывающее, находится ли хост конструктора в текущий момент в процессе транзакции.Gets a value indicating whether the designer host is currently in a transaction.

Loading

Получает значение, показывающее, загружается ли в текущий момент документ хостом конструктора.Gets a value indicating whether the designer host is currently loading the document.

RootComponent

Получает экземпляр базового класса, используемого в качестве корневого компонента для текущего конструктора.Gets the instance of the base class used as the root component for the current design.

RootComponentClassName

Получает полное имя разрабатываемого класса.Gets the fully qualified name of the class being designed.

TransactionDescription

Получает описание текущей транзакции.Gets the description of the current transaction.

Методы

Activate()

Активизирует конструктор, размещенный на данном хосте.Activates the designer that this host is hosting.

AddService(Type, Object)

Добавляет заданную службу в контейнер служб.Adds the specified service to the service container.

(Унаследовано от IServiceContainer)
AddService(Type, Object, Boolean)

Добавляет заданную службу в контейнер служб и дополнительно распространяет ее во все родительские контейнеры служб.Adds the specified service to the service container, and optionally promotes the service to any parent service containers.

(Унаследовано от IServiceContainer)
AddService(Type, ServiceCreatorCallback)

Добавляет заданную службу в контейнер служб.Adds the specified service to the service container.

(Унаследовано от IServiceContainer)
AddService(Type, ServiceCreatorCallback, Boolean)

Добавляет заданную службу в контейнер служб и дополнительно распространяет ее в родительские контейнеры служб.Adds the specified service to the service container, and optionally promotes the service to parent service containers.

(Унаследовано от IServiceContainer)
CreateComponent(Type)

Создает компонент указанного типа и добавляет его в документ проекта.Creates a component of the specified type and adds it to the design document.

CreateComponent(Type, String)

Создает компонент с заданным типом и именем и добавляет его в документ проекта.Creates a component of the specified type and name, and adds it to the design document.

CreateTransaction()

Создает класс DesignerTransaction, который может инкапсулировать последовательности событий для повышения производительности, а также для включения вспомогательных функциональных возможностей: отмены и возврата.Creates a DesignerTransaction that can encapsulate event sequences to improve performance and enable undo and redo support functionality.

CreateTransaction(String)

Создает класс DesignerTransaction, который может инкапсулировать последовательности событий для повышения производительности, а также для включения вспомогательных функциональных возможностей: отмены и возврата, с помощью заданного описания транзакции.Creates a DesignerTransaction that can encapsulate event sequences to improve performance and enable undo and redo support functionality, using the specified transaction description.

DestroyComponent(IComponent)

Уничтожает заданный компонент и удаляет его из контейнера конструктора.Destroys the specified component and removes it from the designer container.

GetDesigner(IComponent)

Получает экземпляр конструктора, содержащий указанный компонент.Gets the designer instance that contains the specified component.

GetService(Type)

Возвращает объект обслуживания указанного типа.Gets the service object of the specified type.

(Унаследовано от IServiceProvider)
GetType(String)

Получает экземпляр заданного полного имени типа.Gets an instance of the specified, fully qualified type name.

RemoveService(Type)

Удаляет службы указанного типа из контейнера служб.Removes the specified service type from the service container.

(Унаследовано от IServiceContainer)
RemoveService(Type, Boolean)

Удаляет заданный тип службы из контейнера служб и дополнительно распространяет службу в родительские контейнеры служб.Removes the specified service type from the service container, and optionally promotes the service to parent service containers.

(Унаследовано от IServiceContainer)

События

Activated

Возникает, когда конструктор активизирован.Occurs when this designer is activated.

Deactivated

Возникает, когда данный конструктор отключен.Occurs when this designer is deactivated.

LoadComplete

Возникает, когда конструктор завершил загрузку документа.Occurs when this designer completes loading its document.

TransactionClosed

Добавляет обработчик событий для события TransactionClosed.Adds an event handler for the TransactionClosed event.

TransactionClosing

Добавляет обработчик событий для события TransactionClosing.Adds an event handler for the TransactionClosing event.

TransactionOpened

Добавляет обработчик событий для события TransactionOpened.Adds an event handler for the TransactionOpened event.

TransactionOpening

Добавляет обработчик событий для события TransactionOpening.Adds an event handler for the TransactionOpening event.

Применяется к

Дополнительно