IDesignerHost インターフェイス

リファレンス

定義

名前空間:: System.ComponentModel.Design

アセンブリ:: System.ComponentModel.TypeConverter.dll

アセンブリ:: System.dll

アセンブリ:: netstandard.dll

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

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

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

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

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

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

public interface IDesignerHost : System.ComponentModel.Design.IServiceContainer

type IDesignerHost = interface
    interface IServiceContainer
    interface IServiceProvider

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

Public Interface IDesignerHost
Implements IServiceContainer, IServiceProvider

Public Interface IDesignerHost
Implements IServiceContainer

派生: 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)	指定されたサービスをサービスコンテナーに追加します。 (継承元 IServiceContainer)
AddService(Type, Object, Boolean)	指定されたサービスをサービスコンテナーに追加し、必要に応じてサービスを任意の親サービスコンテナーに昇格します。 (継承元 IServiceContainer)
AddService(Type, ServiceCreatorCallback)	指定されたサービスをサービスコンテナーに追加します。 (継承元 IServiceContainer)
AddService(Type, ServiceCreatorCallback, Boolean)	指定されたサービスをサービスコンテナーに追加し、必要に応じてサービスを親サービスコンテナーに昇格します。 (継承元 IServiceContainer)
CreateComponent(Type)	指定した型のコンポーネントを作成し、そのコンポーネントをデザインドキュメントに追加します。
CreateComponent(Type, String)	指定した型および名前のコンポーネントを作成し、そのコンポーネントをデザインドキュメントに追加します。
CreateTransaction()	一連のイベントをカプセル化することでパフォーマンスを向上させ、"元に戻す" 機能や "やり直し" 機能をサポートできるようにする DesignerTransaction を作成します。
CreateTransaction(String)	指定したトランザクションの説明を使用して、一連のイベントをカプセル化することでパフォーマンスを向上させ、"元に戻す" 機能や "やり直し" 機能をサポートできるようにする DesignerTransaction を作成します。
DestroyComponent(IComponent)	指定したコンポーネントを破棄し、デザイナーコンテナーからそのコンポーネントを削除します。
GetDesigner(IComponent)	指定したコンポーネントを格納しているデザイナーインスタンスを取得します。
GetService(Type)	指定した型のサービスオブジェクトを取得します。 (継承元 IServiceProvider)
GetType(String)	指定した完全限定型名のインスタンスを取得します。
RemoveService(Type)	指定されたサービスの型をサービスコンテナーから削除します。 (継承元 IServiceContainer)
RemoveService(Type, Boolean)	指定されたサービスの型をサービスコンテナーから削除し、必要に応じてサービスを親サービスコンテナーに昇格します。 (継承元 IServiceContainer)

イベント

Activated	デザイナーがアクティブになるときに発生します。
Deactivated	デザイナーがアクティブでなくなるときに発生します。
LoadComplete	デザイナーがドキュメントの読み込みを完了したときに発生します。
TransactionClosed	TransactionClosed イベントのイベントハンドラーを追加します。
TransactionClosing	TransactionClosing イベントのイベントハンドラーを追加します。
TransactionOpened	TransactionOpened イベントのイベントハンドラーを追加します。
TransactionOpening	TransactionOpening イベントのイベントハンドラーを追加します。

拡張メソッド

GetKeyedService<T>(IServiceProvider, Object)	から型 `T` のサービスを取得します IServiceProvider。
GetKeyedServices(IServiceProvider, Type, Object)	から型 `serviceType` のサービスの列挙体を取得します IServiceProvider。
GetKeyedServices<T>(IServiceProvider, Object)	から型 `T` のサービスの列挙体を取得します IServiceProvider。
GetRequiredKeyedService(IServiceProvider, Type, Object)	から型 `serviceType` のサービスを取得します IServiceProvider。
GetRequiredKeyedService<T>(IServiceProvider, Object)	から型 `T` のサービスを取得します IServiceProvider。
CreateAsyncScope(IServiceProvider)	スコープサービスを解決するために使用できる新しい AsyncServiceScope を作成します。
CreateScope(IServiceProvider)	スコープサービスを解決するために使用できる新しい IServiceScope を作成します。
GetRequiredService(IServiceProvider, Type)	IServiceProvider から `serviceType` 型のサービスを取得します。
GetRequiredService<T>(IServiceProvider)	IServiceProvider から `T` 型のサービスを取得します。
GetService<T>(IServiceProvider)	IServiceProvider から `T` 型のサービスを取得します。
GetServices(IServiceProvider, Type)	IServiceProvider から `serviceType` 型のサービスの列挙体を取得します。
GetServices<T>(IServiceProvider)	IServiceProvider から `T` 型のサービスの列挙体を取得します。
GetFakeLogCollector(IServiceProvider)	偽のロガーに送信されたログレコードを収集するオブジェクトを取得します。
GetFakeRedactionCollector(IServiceProvider)	依存関係挿入コンテナーから偽の redactor コレクターインスタンスを取得します。

適用対象

製品	バージョン
.NET	Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework	1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard	2.0, 2.1

次の方法で共有