IDesignerHost Interfész

Definíció

Névtér:

System.ComponentModel.Design

Szerelvények:

netstandard.dll, System.ComponentModel.TypeConverter.dll

Forrás:

IDesignerHost.cs

Kezelőfelületet biztosít a tervezői tranzakciók és összetevők kezeléséhez.

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

Származtatott

System.ComponentModel.Design.Serialization.IDesignerLoaderHost

System.ComponentModel.Design.Serialization.IDesignerLoaderHost2

Megvalósítás

IServiceContainer IServiceProvider

Példák

Az alábbi példakód bemutatja, hogyan szerezheti be a IDesignerHost szolgáltatásfelületet egy tervezőtől vagy egy helyhez tartozó összetevőtől.

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

Az alábbi példakód bemutatja, hogy a felület használatával listázhatja a IDesignerHost projektösszetevőket.

#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

Megjegyzések

IDesignerHost egy felület, amely a .NET Keretrendszer űrlaptervező architektúrájával együttműködve támogatja a tervezői tranzakciókat és az összetevők kezelését.

A .NET-keretrendszer nem biztosítja ennek a felületnek a megvalósítását. A felületet tervezőket támogató fejlesztői eszközök implementálják.

Megjegyzések a hívókhoz

Ha egy fejlesztési környezetből szeretne implementációt IDesignerHost beszerezni, hívja meg GetService(Type) , amíg az összetevő aktív tervezési módban van, és átadja a szolgáltatási felület kérésének IDesignerHostIDesignerHost típusát.

IDesignerHost a tervezői állapothoz kapcsolódó következő tagokat biztosítja:

• A Loading tulajdonság azt jelzi, hogy egy tervező vagy dokumentum be van-e töltve.

• Az Activated esemény akkor következik be, ha a tervező aktiválása a megjelenítés előtt történik.

• Az Deactivated esemény akkor következik be, ha egy tervező inaktiválva van.

• Az LoadComplete esemény egy dokumentum betöltése után következik be.

• A Activate() metódus aktiválja a tervezőt.

IDesignerHost az összetevők kezelésével kapcsolatos alábbi tagokat biztosítja:

• A Container tulajdonság a tervező gazdagép tárolója.

• A RootComponent tulajdonság a gyökérösszetevő alaposztályát jelzi.

• A RootComponentClassName tulajdonság a gyökérösszetevő osztályának nevét jelzi.

• A CreateComponent(Type) metódus létrehozza a megadott összetevőtípust.

• A DestroyComponent(IComponent) metódus megsemmisíti a megadott összetevőt.

• A GetDesigner(IComponent) metódus lekéri a tervezőt egy megadott összetevőhöz.

• A GetType(String) metódus lekéri a megadott névvel rendelkező típuspéldányt.

IDesignerHost a tranzakciók kezelésével kapcsolatos alábbi tagokat biztosítja:

• A InTransaction tulajdonság azt jelzi, hogy a tervező tranzakcióban van-e.

• A TransactionDescription tulajdonság az aktuális tranzakció leírását jelzi.

• Az TransactionClosed esemény akkor következik be, ha egy tranzakció befejeződött.

• Az TransactionClosing esemény akkor következik be, ha egy tranzakció hamarosan befejeződik.

• Az TransactionOpened esemény akkor következik be, ha egy tranzakció elkezdődött.

• Az TransactionOpening esemény akkor következik be, amikor egy tranzakció megkezdődik.

• A CreateTransaction() metódus létrehoz és visszaad egy új tranzakciót.

Tulajdonságok

Name	Description
Container	Lekéri a tervező gazdagép tárolót.
InTransaction	Beolvas egy értéket, amely jelzi, hogy a tervező gazdagép jelenleg tranzakcióban van-e.
Loading	Beolvas egy értéket, amely jelzi, hogy a tervező gazdagép éppen betölti-e a dokumentumot.
RootComponent	Lekéri az aktuális tervezés gyökérösszetevőjeként használt alaposztály példányát.
RootComponentClassName	Lekéri a tervezett osztály teljes nevét.
TransactionDescription	Lekéri az aktuális tranzakció leírását.

Metódusok

Name	Description
Activate()	Aktiválja a gazdagép által üzemeltetett tervezőt.
AddService(Type, Object, Boolean)	Hozzáadja a megadott szolgáltatást a szolgáltatástárolóhoz, és opcionálisan előlépteti a szolgáltatást bármely szülőszolgáltatás-tárolóban. (Öröklődés forrása IServiceContainer)
AddService(Type, Object)	Hozzáadja a megadott szolgáltatást a szolgáltatástárolóhoz. (Öröklődés forrása IServiceContainer)
AddService(Type, ServiceCreatorCallback, Boolean)	Hozzáadja a megadott szolgáltatást a szolgáltatástárolóhoz, és opcionálisan előlépteti a szolgáltatást a szülőszolgáltatás-tárolókhoz. (Öröklődés forrása IServiceContainer)
AddService(Type, ServiceCreatorCallback)	Hozzáadja a megadott szolgáltatást a szolgáltatástárolóhoz. (Öröklődés forrása IServiceContainer)
CreateComponent(Type, String)	Létrehoz egy összetevőt a megadott típusból és névből, és hozzáadja a terveződokumentumhoz.
CreateComponent(Type)	Létrehozza a megadott típusú összetevőt, és hozzáadja a terveződokumentumhoz.
CreateTransaction()	Létrehoz egy olyan eseményütemezéseket DesignerTransaction , amelyek javítják a teljesítményt, és lehetővé teszik a visszavonást, és újra elvégzik a támogatási funkciókat.
CreateTransaction(String)	Létrehoz egy DesignerTransaction olyan eseményütemezéseket, amelyek javítják a teljesítményt, és engedélyezik a visszavonást, és újra elvégzik a támogatási funkciókat a megadott tranzakcióleírás használatával.
DestroyComponent(IComponent)	Megsemmisíti a megadott összetevőt, és eltávolítja azt a tervezőtárolóból.
GetDesigner(IComponent)	Lekéri a megadott összetevőt tartalmazó tervezőpéldányt.
GetService(Type)	Lekéri a megadott típusú szolgáltatásobjektumot. (Öröklődés forrása IServiceProvider)
GetType(String)	Lekéri a megadott, teljes típusnév egy példányát.
RemoveService(Type, Boolean)	Eltávolítja a megadott szolgáltatástípust a szolgáltatástárolóból, és opcionálisan előlépteti a szolgáltatást a szülőszolgáltatás-tárolókra. (Öröklődés forrása IServiceContainer)
RemoveService(Type)	Eltávolítja a megadott szolgáltatástípust a szolgáltatástárolóból. (Öröklődés forrása IServiceContainer)

esemény

Name	Description
Activated	Ez akkor fordul elő, ha a tervező aktiválva van.
Deactivated	Ez akkor fordul elő, ha a tervező inaktiválva van.
LoadComplete	Ez akkor fordul elő, ha a tervező befejezi a dokumentum betöltését.
TransactionClosed	Hozzáad egy eseménykezelőt az TransactionClosed eseményhez.
TransactionClosing	Hozzáad egy eseménykezelőt az TransactionClosing eseményhez.
TransactionOpened	Hozzáad egy eseménykezelőt az TransactionOpened eseményhez.
TransactionOpening	Hozzáad egy eseménykezelőt az TransactionOpening eseményhez.

Lásd még

• IDesigner
• IDesignerEventService
• IDesignerOptionService