IDesignerHost インターフェイス

定義

名前空間:

System.ComponentModel.Design

アセンブリ:

System.dll

デザイナーのトランザクションとコンポーネントを管理するためのインターフェイスを提供します。

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

[System.Runtime.InteropServices.ComVisible(true)]
public interface IDesignerHost : IServiceProvider, System.ComponentModel.Design.IServiceContainer

[<System.Runtime.InteropServices.ComVisible(true)>]
type IDesignerHost = interface
    interface IServiceContainer
    interface IServiceProvider

Public Interface IDesignerHost
Implements IServiceContainer, IServiceProvider

派生

System.ComponentModel.Design.Serialization.IDesignerLoaderHost

System.ComponentModel.Design.Serialization.IDesignerLoaderHost2

属性

ComVisibleAttribute

実装

IServiceContainer IServiceProvider

例

次のコード例は、デザイナーまたはサイト コンポーネントから IDesignerHost サービス インターフェイスを取得する方法を示しています。

// 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 インターフェイスを使用してプロジェクト コンポーネントを一覧表示する方法を示しています。

#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

注釈

IDesignerHost は、.NET Framework フォーム デザイナー アーキテクチャと連携して、デザイナーのトランザクションとコンポーネントの管理をサポートするインターフェイスです。

.NET Framework では、このインターフェイスの実装は提供されません。 インターフェイスは、デザイナーをサポートする開発ツールによって実装されます。

注意 (呼び出し元)

開発環境からIDesignerHostの実装を取得するには、コンポーネントがデザイン モードでアクティブな間にGetService(Type)を呼び出し、IDesignerHost サービス インターフェイスを要求するIDesignerHostの種類を渡します。

IDesignerHost には、デザイナーの状態に関連する次のメンバーが用意されています。

• Loading プロパティは、デザイナーまたはドキュメントが読み込まれているかどうかを示します。

• Activated イベントは、デザイナーが表示前にアクティブになったときに発生します。

• Deactivated イベントは、デザイナーが非アクティブ化されるときに発生します。

• LoadComplete イベントは、ドキュメントが読み込まれた後に発生します。

• Activate() メソッドはデザイナーをアクティブにします。

IDesignerHost には、コンポーネントの管理に関連する次のメンバーが用意されています。

• Container プロパティは、デザイナー ホストのコンテナーを示します。

• RootComponent プロパティは、ルート コンポーネントの基底クラスを示します。

• RootComponentClassName プロパティは、ルート コンポーネントのクラスの名前を示します。

• CreateComponent(Type) メソッドは、指定した種類のコンポーネントを作成します。

• DestroyComponent(IComponent) メソッドは、指定したコンポーネントを破棄します。

• GetDesigner(IComponent) メソッドは、指定したコンポーネントに関連付けられているデザイナーを取得します。

• GetType(String) メソッドは、指定した名前の型のインスタンスを取得します。

IDesignerHost には、トランザクションの管理に関連する次のメンバーが用意されています。

• InTransaction プロパティは、デザイナーがトランザクション内にあるかどうかを示します。

• TransactionDescription プロパティは、現在のトランザクションの説明を示します。

• TransactionClosed イベントは、トランザクションが完了したときに発生します。

• TransactionClosing イベントは、トランザクションが完了しようとしているときに発生します。

• TransactionOpened イベントは、トランザクションが開始されたときに発生します。

• TransactionOpening イベントは、トランザクションが開始されようとしているときに発生します。

• CreateTransaction() メソッドは、新しいトランザクションを作成して返します。

プロパティ

名前	説明
Container	このデザイナー ホストのコンテナーを取得します。
InTransaction	デザイナー ホストが現在トランザクション内にあるかどうかを示す値を取得します。
Loading	デザイナー ホストが現在ドキュメントを読み込んでいるかどうかを示す値を取得します。
RootComponent	現在のデザインのルート コンポーネントとして使用される基底クラスのインスタンスを取得します。
RootComponentClassName	設計されているクラスの完全修飾名を取得します。
TransactionDescription	現在のトランザクションの説明を取得します。

メソッド

名前	説明
Activate()	このホストがホストしているデザイナーをアクティブにします。
AddService(Type, Object, Boolean)	指定したサービスをサービス コンテナーに追加し、必要に応じて、任意の親サービス コンテナーにサービスを昇格させます。 (継承元 IServiceContainer)
AddService(Type, Object)	指定したサービスをサービス コンテナーに追加します。 (継承元 IServiceContainer)
AddService(Type, ServiceCreatorCallback, Boolean)	指定したサービスをサービス コンテナーに追加し、必要に応じて、サービスを親サービス コンテナーに昇格させます。 (継承元 IServiceContainer)
AddService(Type, ServiceCreatorCallback)	指定したサービスをサービス コンテナーに追加します。 (継承元 IServiceContainer)
CreateComponent(Type, String)	指定した型と名前のコンポーネントを作成し、デザイン ドキュメントに追加します。
CreateComponent(Type)	指定した型のコンポーネントを作成し、デザイン ドキュメントに追加します。
CreateTransaction()	イベント シーケンスをカプセル化してパフォーマンスを向上させ、元に戻すおよびやり直しのサポート機能を有効にできる DesignerTransaction を作成します。
CreateTransaction(String)	指定したトランザクションの説明を使用して、イベント シーケンスをカプセル化してパフォーマンスを向上させ、元に戻すおよびやり直しのサポート機能を有効にできる DesignerTransaction を作成します。
DestroyComponent(IComponent)	指定したコンポーネントを破棄し、デザイナー コンテナーから削除します。
GetDesigner(IComponent)	指定したコンポーネントを含むデザイナー インスタンスを取得します。
GetService(Type)	指定した型のサービス オブジェクトを取得します。 (継承元 IServiceProvider)
GetType(String)	指定された完全修飾型名のインスタンスを取得します。
RemoveService(Type, Boolean)	指定したサービスの種類をサービス コンテナーから削除し、必要に応じて、サービスを親サービス コンテナーに昇格させます。 (継承元 IServiceContainer)
RemoveService(Type)	指定したサービスの種類をサービス コンテナーから削除します。 (継承元 IServiceContainer)

イベント

名前	説明
Activated	このデザイナーがアクティブになったときに発生します。
Deactivated	このデザイナーが非アクティブ化されたときに発生します。
LoadComplete	このデザイナーがドキュメントの読み込みを完了したときに発生します。
TransactionClosed	TransactionClosed イベントのイベント ハンドラーを追加します。
TransactionClosing	TransactionClosing イベントのイベント ハンドラーを追加します。
TransactionOpened	TransactionOpened イベントのイベント ハンドラーを追加します。
TransactionOpening	TransactionOpening イベントのイベント ハンドラーを追加します。

こちらもご覧ください

• IDesigner
• IDesignerEventService
• IDesignerOptionService