IDesigner Interface

Definition

Fornece a estrutura básica para a criação de um designer personalizado.Provides the basic framework for building a custom designer.

public interface class IDesigner : IDisposable
public interface IDesigner : IDisposable
[System.Runtime.InteropServices.ComVisible(true)]
public interface IDesigner : IDisposable
type IDesigner = interface
    interface IDisposable
Public Interface IDesigner
Implements IDisposable
Derived
Attributes
Implements

Examples

Este exemplo demonstra uma implementação de IDesigner que armazena uma referência local para seu componente, executa uma ação padrão quando o componente é clicado duas vezes e fornece um comando de menu de verbo de designer.This example demonstrates an IDesigner implementation that stores a local reference to its component, performs a default action when the component is double-clicked, and provides a designer verb menu command.

#using <System.Windows.Forms.dll>
#using <System.Data.dll>
#using <System.Drawing.dll>
#using <System.dll>

using namespace System;
using namespace System::Collections;
using namespace System::ComponentModel;
using namespace System::ComponentModel::Design;
using namespace System::Drawing;
using namespace System::Data;
using namespace System::Windows::Forms;
using namespace System::Security::Permissions;

public ref class ExampleIDesigner: public System::ComponentModel::Design::IDesigner
{
private:

   // Local reference to the designer's component.
   IComponent^ component;

public:

   property System::ComponentModel::IComponent^ Component 
   {
      // Public accessor to the designer's component.
      virtual System::ComponentModel::IComponent^ get()
      {
         return component;
      }
   }
   ExampleIDesigner(){}

   virtual void Initialize( System::ComponentModel::IComponent^ component )
   {
      // This method is called after a designer for a component is created,
      // and stores a reference to the designer's component.
      this->component = component;
   }

   // This method peforms the 'default' action for the designer. The default action 
   // for a basic IDesigner implementation is invoked when the designer's component 
   // is double-clicked. By default, a component associated with a basic IDesigner 
   // implementation is displayed in the design-mode component tray.
   virtual void DoDefaultAction()
   {
      // Shows a message box indicating that the default action for the designer was invoked.
      MessageBox::Show( "The DoDefaultAction method of an IDesigner implementation was invoked.", "Information" );
   }

   property System::ComponentModel::Design::DesignerVerbCollection^ Verbs 
   {
      // Returns a collection of designer verb menu items to show in the 
      // shortcut menu for the designer's component.
      [PermissionSetAttribute(SecurityAction::Demand, Name="FullTrust")]
      virtual System::ComponentModel::Design::DesignerVerbCollection^ get()
      {
         DesignerVerbCollection^ verbs = gcnew DesignerVerbCollection;
         DesignerVerb^ dv1 = gcnew DesignerVerb( "Display Component Name",gcnew EventHandler( this, &ExampleIDesigner::ShowComponentName ) );
         verbs->Add( dv1 );
         return verbs;
      }
   }

private:

   // Event handler for displaying a message box showing the designer's component's name.
   void ShowComponentName( Object^ /*sender*/, EventArgs^ /*e*/ )
   {
      if ( this->Component != nullptr )
            MessageBox::Show( this->Component->Site->Name, "Designer Component's Name" );
   }

public:

   // Provides an opportunity to release resources before object destruction.
   ~ExampleIDesigner(){}

};

// A DesignerAttribute associates the example IDesigner with an example control.

[DesignerAttribute(ExampleIDesigner::typeid)]
public ref class TestControl: public System::Windows::Forms::UserControl
{
public:
   TestControl(){}

};
using System;
using System.Collections;
using System.ComponentModel;
using System.ComponentModel.Design;
using System.Drawing;
using System.Data;
using System.Windows.Forms;

namespace IDesignerExample
{	
    // A DesignerAttribute associates the example IDesigner with an example control.
    [DesignerAttribute(typeof(ExampleIDesigner))]
    public class TestControl : System.Windows.Forms.UserControl
    {				
        public TestControl()
        {	
        }
    }

    [System.Security.Permissions.PermissionSet(System.Security.Permissions.SecurityAction.Demand, Name = "FullTrust")] 
    public class ExampleIDesigner : System.ComponentModel.Design.IDesigner
    {
        // Local reference to the designer's component.
        private IComponent component; 
        // Public accessor to the designer's component.
        public System.ComponentModel.IComponent Component
        {
            get
            {
                return component;
            }            
        }

        public ExampleIDesigner()
        {            
        }

        public void Initialize(System.ComponentModel.IComponent component)
        {
            // This method is called after a designer for a component is created,
            // and stores a reference to the designer's component.
            this.component = component;
        }        
        
        // This method peforms the 'default' action for the designer. The default action 
        // for a basic IDesigner implementation is invoked when the designer's component 
        // is double-clicked. By default, a component associated with a basic IDesigner 
        // implementation is displayed in the design-mode component tray.
        public void DoDefaultAction()
        {
            // Shows a message box indicating that the default action for the designer was invoked.
            MessageBox.Show("The DoDefaultAction method of an IDesigner implementation was invoked.", "Information");
        }

        // Returns a collection of designer verb menu items to show in the 
        // shortcut menu for the designer's component.
        public System.ComponentModel.Design.DesignerVerbCollection Verbs
        {
            get
            {
                DesignerVerbCollection verbs = new DesignerVerbCollection();
                DesignerVerb dv1 = new DesignerVerb("Display Component Name", new EventHandler(this.ShowComponentName));
                verbs.Add( dv1 );
                return verbs;
            }
        }

        // Event handler for displaying a message box showing the designer's component's name.
        private void ShowComponentName(object sender, EventArgs e)
        {
            if( this.Component != null )
                MessageBox.Show( this.Component.Site.Name, "Designer Component's Name" );
        }

        // Provides an opportunity to release resources before object destruction.
        public void Dispose()
        {        
        }
    }
}
Imports System.Collections
Imports System.ComponentModel
Imports System.ComponentModel.Design
Imports System.Drawing
Imports System.Windows.Forms

' A DesignerAttribute associates the example IDesigner with an example control.
<DesignerAttribute(GetType(ExampleIDesigner))> _
Public Class TestControl
    Inherits System.Windows.Forms.UserControl

    Public Sub New()
    End Sub
End Class

<System.Security.Permissions.PermissionSetAttribute(System.Security.Permissions.SecurityAction.Demand, Name:="FullTrust")> _
Public Class ExampleIDesigner
    Implements System.ComponentModel.Design.IDesigner

    ' Local reference to the designer's component.
    Private _component As IComponent

    ' Public accessor to the designer's component.
    Public ReadOnly Property Component() As System.ComponentModel.IComponent Implements IDesigner.Component
        Get
            Return _component
        End Get
    End Property

    Public Sub New()
    End Sub

    Public Sub Initialize(ByVal component As System.ComponentModel.IComponent) Implements IDesigner.Initialize
        ' This method is called after a designer for a component is created,
        ' and stores a reference to the designer's component.
        Me._component = component
    End Sub

    ' This method peforms the 'default' action for the designer. The default action 
    ' for a basic IDesigner implementation is invoked when the designer's component 
    ' is double-clicked. By default, a component associated with a basic IDesigner 
    ' implementation is displayed in the design-mode component tray.
    Public Sub DoDefaultAction() Implements IDesigner.DoDefaultAction
        ' Shows a message box indicating that the default action for the designer was invoked.
        MessageBox.Show("The DoDefaultAction method of an IDesigner implementation was invoked.", "Information")
    End Sub

    ' Returns a collection of designer verb menu items to show in the 
    ' shortcut menu for the designer's component.
    Public ReadOnly Property Verbs() As System.ComponentModel.Design.DesignerVerbCollection Implements IDesigner.Verbs
        Get
            Dim verbs_ As New DesignerVerbCollection()
            Dim dv1 As New DesignerVerb("Display Component Name", New EventHandler(AddressOf Me.ShowComponentName))
            verbs_.Add(dv1)
            Return verbs_
        End Get
    End Property

    ' Event handler for displaying a message box showing the designer's component's name.
    Private Sub ShowComponentName(ByVal sender As Object, ByVal e As EventArgs)
        If (Me.Component IsNot Nothing) Then
            MessageBox.Show(Me.Component.Site.Name, "Designer Component's Name")
        End If
    End Sub

    ' Provides an opportunity to release resources before object destruction.
    Public Sub Dispose() Implements IDisposable.Dispose
    End Sub

End Class

Remarks

A interface IDesigner fornece uma interface por meio da qual você pode implementar serviços básicos para um designer.The IDesigner interface provides an interface through which you can implement basic services for a designer. Um designer pode modificar o comportamento de um componente em tempo de design e pode fornecer seus próprios serviços e comportamento.A designer can modify the behavior of a component at design time, and may provide its own services and behavior. Um designer só está ativo em tempo de design e deve ser associado a um tipo de componente usando um DesignerAttribute para ser carregado quando um componente do tipo associado é criado em tempo de design.A designer is only active at design-time, and must be associated with a type of component using a DesignerAttribute in order to be loaded when a component of the associated type is created at design time.

A interface IDesigner fornece métodos e propriedades que você pode implementar para fornecer comportamento personalizado em tempo de design.The IDesigner interface provides methods and properties that you can implement in order to provide custom behavior at design time.

Implemente o método Initialize de um designer para executar ações quando um componente é criado.Implement the Initialize method of a designer to perform actions when a component is created. Isso pode ser útil se um componente deve ter uma configuração especial em tempo de design ou se sua configuração deve ser alterada dependendo das condições que o designer pode determinar.This can be useful if a component should have a special configuration at design-time, or if its configuration should change depending on conditions that the designer can determine.

Um designer pode fornecer comandos de menu no menu de atalho que é exibido quando um usuário clica com o botão direito do mouse em um componente ou controle no ambiente de tempo de design.A designer can provide menu commands on the shortcut menu that is displayed when a user right-clicks a component or control in the design-time environment. Você pode implementar a propriedade Verbs para definir um acessador get que retorna um DesignerVerbCollection contendo os objetos DesignerVerb para gerar comandos de menu.You can implement the Verbs property to define a get accessor that returns a DesignerVerbCollection containing the DesignerVerb objects for generating menu commands.

Um designer para um componente que aparece na bandeja de componentes pode executar uma ação padrão quando o componente é clicado duas vezes.A designer for a component that appears in the component tray can perform a default action when the component is double-clicked. Implemente o método DoDefaultAction para especificar o comportamento a ser executado quando o componente for clicado duas vezes.Implement the DoDefaultAction method to specify the behavior to perform when the component is double-clicked.

Um designer também pode usar os serviços de tempo de design disponíveis para executar uma variedade de tarefas, incluindo a pesquisa do ambiente atual de tempo de design para componentes e suas propriedades, leitura e configuração de valores de propriedades de componentes, gerenciamento da caixa de ferramentas, gerenciamento de componentes selecionados ou exibição de uma interface do usuário que pode ser usada para configurar valores ou para aplicar processamento adicional.A designer can also use the available design-time services to perform a variety of tasks, including surveying the current design-time environment for components and their properties, reading and setting the values of properties of components, managing the toolbox, managing selected components, or displaying a user interface that can be used to configure values or to apply further processing.

Para implementar um designer para um controle que pode ser site em um formulário, você pode herdar da classe ControlDesigner.To implement a designer for a control that can be sited on a form, you can inherit from the ControlDesigner class. Controles cujo designer associado não deriva de ControlDesigner são exibidos na bandeja de componentes.Controls whose associated designer does not derive from ControlDesigner are displayed in the component tray. As classes ComponentDesigner e ControlDesigner implementam a interface IDesigner e fornecem suporte adicional ao tempo de design que pode ser usado para autores de designers.The ComponentDesigner and ControlDesigner classes implement the IDesigner interface and provide additional design-time support that may be of use to authors of designers. Para obter mais informações, consulte a documentação de referência para essas classes.For more information, see the reference documentation for these classes.

Para obter uma visão geral da criação de componentes de design, consulte estendendo o suporte ao tempo de design.For an overview of creating design components, please see Extending Design-Time Support.

Properties

Component

Obtém o componente de base que este designer está criando.Gets the base component that this designer is designing.

Verbs

Obtém uma coleção dos verbos em tempo de design compatíveis com o designer.Gets a collection of the design-time verbs supported by the designer.

Methods

Dispose()

Executa tarefas definidas pelo aplicativo associadas à liberação ou redefinição de recursos não gerenciados.Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

(Inherited from IDisposable)
DoDefaultAction()

Executa a ação padrão para este designer.Performs the default action for this designer.

Initialize(IComponent)

Inicializa o designer com o componente especificado.Initializes the designer with the specified component.

Applies to

See also