IDesignerHost Rozhraní

Reference

Definice

Obor názvů:: System.ComponentModel.Design

Sestavení:: System.ComponentModel.TypeConverter.dll

Sestavení:: System.dll

Sestavení:: netstandard.dll

Důležité

Některé informace platí pro předběžně vydaný produkt, který se může zásadně změnit, než ho výrobce nebo autor vydá. Microsoft neposkytuje žádné záruky, výslovné ani předpokládané, týkající se zde uváděných informací.

Poskytuje rozhraní pro správu návrhář transakce a komponenty.

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

Odvozené: System.ComponentModel.Design.Serialization.IDesignerLoaderHost

System.ComponentModel.Design.Serialization.IDesignerLoaderHost2

Atributy: ComVisibleAttribute

Implementuje: IServiceContainer IServiceProvider

Příklady

Následující příklad kódu ukazuje, jak získat IDesignerHost rozhraní služby z návrháře nebo sited komponenty.

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

Následující příklad kódu ukazuje použití IDesignerHost rozhraní k výpisu součástí 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

Poznámky

IDesignerHost je rozhraní, které pracuje s architekturou návrháře formulářů rozhraní .NET Framework a poskytuje podporu pro správu komponent a transakcí návrháře.

Rozhraní .NET Framework neposkytuje implementaci tohoto rozhraní. Rozhraní je implementováno vývojovými nástroji, které podporují návrháře.

Poznámky pro volající

Pokud chcete získat implementaci z vývojového IDesignerHost prostředí, zavolejte GetService(Type) , když je komponenta aktivní v režimu návrhu, a předejte typ IDesignerHost do vyžádání IDesignerHost rozhraní služby.

IDesignerHost poskytuje následující členy související se stavem návrháře:

Vlastnost Loading označuje, zda se načítá návrhář nebo dokument.
Událost Activated nastane, když je návrhář aktivován před zobrazením.
Událost Deactivated nastane, když je deaktivován návrhář.
Událost LoadComplete nastane po načtení dokumentu.
Metoda Activate() aktivuje návrháře.

IDesignerHost poskytuje následující členy související se správou komponent:

Vlastnost Container označuje kontejner pro hostitele návrháře.
Vlastnost RootComponent označuje základní třídu pro kořenovou komponentu.
Vlastnost RootComponentClassName označuje název třídy kořenové komponenty.
Metoda CreateComponent(Type) vytvoří zadaný typ komponenty.
Metoda DestroyComponent(IComponent) zničí zadanou komponentu.
Metoda GetDesigner(IComponent) získá návrhář přidružený k zadané komponentě.
Metoda GetType(String) získá instanci typu se zadaným názvem.

IDesignerHost poskytuje následující členy související se správou transakcí:

Vlastnost InTransaction označuje, zda návrhář je v transakci.
Vlastnost TransactionDescription označuje popis aktuální transakce.
Událost TransactionClosed nastane po dokončení transakce.
Událost TransactionClosing nastane, když se transakce má dokončit.
Událost TransactionOpened nastane při zahájení transakce.
Událost TransactionOpening nastane, když se blíží zahájení transakce.
Metoda CreateTransaction() vytvoří a vrátí novou transakci.

Vlastnosti

Container	Získá kontejner pro tohoto hostitele návrháře.
InTransaction	Získá hodnotu označující, zda je hostitel návrháře aktuálně v transakci.
Loading	Získá hodnotu označující, zda návrhář hostitel je aktuálně načítá dokument.
RootComponent	Získá instanci základní třídy použité jako kořenová komponenta pro aktuální návrh.
RootComponentClassName	Získá plně kvalifikovaný název třídy je navržena.
TransactionDescription	Získá popis aktuální transakce.

Metody

Activate()	Aktivuje návrháře, který tento hostitel hostuje.
AddService(Type, Object)	Přidá zadanou službu do kontejneru služby. (Zděděno od IServiceContainer)
AddService(Type, Object, Boolean)	Přidá zadanou službu do kontejneru služby a volitelně ji propaguje na všechny nadřazené kontejnery služby. (Zděděno od IServiceContainer)
AddService(Type, ServiceCreatorCallback)	Přidá zadanou službu do kontejneru služby. (Zděděno od IServiceContainer)
AddService(Type, ServiceCreatorCallback, Boolean)	Přidá zadanou službu do kontejneru služby a volitelně ji propaguje na nadřazené kontejnery služby. (Zděděno od IServiceContainer)
CreateComponent(Type)	Vytvoří součást zadaného typu a přidá ji do dokumentu návrhu.
CreateComponent(Type, String)	Vytvoří součást zadaného typu a názvu a přidá ji do dokumentu návrhu.
CreateTransaction()	Vytvoří , DesignerTransaction který může zapouzdřovat sekvence událostí za účelem zvýšení výkonu a povolení funkce podpory vrácení zpět a znovu.
CreateTransaction(String)	Vytvoří , DesignerTransaction který může zapouzdřovat sekvence událostí ke zlepšení výkonu a povolit funkce podpory zpět a znovu pomocí zadaného popisu transakce.
DestroyComponent(IComponent)	Zničí zadanou komponentu a odebere ji z kontejneru návrháře.
GetDesigner(IComponent)	Získá instanci návrháře, která obsahuje zadanou komponentu.
GetService(Type)	Získá objekt služby zadaného typu. (Zděděno od IServiceProvider)
GetType(String)	Získá instanci zadaného plně kvalifikovaného názvu typu.
RemoveService(Type)	Odebere zadaný typ služby z kontejneru služby. (Zděděno od IServiceContainer)
RemoveService(Type, Boolean)	Odebere zadaný typ služby z kontejneru služby a volitelně službu povýší na nadřazené kontejnery služby. (Zděděno od IServiceContainer)

Událost

Activated	Vyvolá se při aktivaci tohoto návrháře.
Deactivated	Vyvolá se při deaktivaci tohoto návrháře.
LoadComplete	Vyvolá se při tomto návrháři dokončí načítání dokumentu.
TransactionClosed	Přidá obslužnou rutinu TransactionClosed události pro událost.
TransactionClosing	Přidá obslužnou rutinu TransactionClosing události pro událost.
TransactionOpened	Přidá obslužnou rutinu TransactionOpened události pro událost.
TransactionOpening	Přidá obslužnou rutinu TransactionOpening události pro událost.

Metody rozšíření

GetKeyedService<T>(IServiceProvider, Object)	Získá službu typu `T` z .IServiceProvider
GetKeyedServices(IServiceProvider, Type, Object)	Získá výčet služeb typu `serviceType` z IServiceProvider.
GetKeyedServices<T>(IServiceProvider, Object)	Získá výčet služeb typu `T` z IServiceProvider.
GetRequiredKeyedService(IServiceProvider, Type, Object)	Získá službu typu `serviceType` z .IServiceProvider
GetRequiredKeyedService<T>(IServiceProvider, Object)	Získá službu typu `T` z .IServiceProvider
CreateAsyncScope(IServiceProvider)	Vytvoří nový AsyncServiceScope , který lze použít k vyřešení služeb s vymezeným oborem.
CreateScope(IServiceProvider)	Vytvoří nový IServiceScope , který lze použít k vyřešení služeb s vymezeným oborem.
GetRequiredService(IServiceProvider, Type)	Získejte službu typu `serviceType` z .IServiceProvider
GetRequiredService<T>(IServiceProvider)	Získejte službu typu `T` z .IServiceProvider
GetService<T>(IServiceProvider)	Získejte službu typu `T` z .IServiceProvider
GetServices(IServiceProvider, Type)	Získejte výčet služeb typu `serviceType` z .IServiceProvider
GetServices<T>(IServiceProvider)	Získejte výčet služeb typu `T` z .IServiceProvider
GetFakeLogCollector(IServiceProvider)	Získá objekt, který shromažďuje záznamy protokolu odeslané do falešné protokolovací nástroje.
GetFakeRedactionCollector(IServiceProvider)	Získá falešné redactor kolektor instance z kontejneru injektáž závislostí.

Platí pro

Sdílet prostřednictvím