Mise à jour : novembre 2007
Fournit une implémentation de base d'un élément de boîte à outils.
Espace de noms :
System.Drawing.Design Assembly :
System.Drawing (dans System.Drawing.dll)
Visual Basic (Déclaration)
<SerializableAttribute> _
<PermissionSetAttribute(SecurityAction.InheritanceDemand, Name := "FullTrust")> _
<PermissionSetAttribute(SecurityAction.LinkDemand, Name := "FullTrust")> _
Public Class ToolboxItem _
Implements ISerializable
Visual Basic (Utilisation)
Dim instance As ToolboxItem
[SerializableAttribute]
[PermissionSetAttribute(SecurityAction.InheritanceDemand, Name = "FullTrust")]
[PermissionSetAttribute(SecurityAction.LinkDemand, Name = "FullTrust")]
public class ToolboxItem : ISerializable
[SerializableAttribute]
[PermissionSetAttribute(SecurityAction::InheritanceDemand, Name = L"FullTrust")]
[PermissionSetAttribute(SecurityAction::LinkDemand, Name = L"FullTrust")]
public ref class ToolboxItem : ISerializable
/** @attribute SerializableAttribute */
/** @attribute PermissionSetAttribute(SecurityAction.InheritanceDemand, Name = "FullTrust") */
/** @attribute PermissionSetAttribute(SecurityAction.LinkDemand, Name = "FullTrust") */
public class ToolboxItem implements ISerializable
public class ToolboxItem implements ISerializable
ToolboxItem est une classe de base pour les éléments de boîte à outils pouvant être affichés dans la boîte à outils d'un environnement de design. Un élément de boîte à outils représente généralement un composant à créer lorsqu'il est appelé sur un document en mode design. La classe ToolboxItem fournit les méthodes et les propriétés nécessaires pour doter la boîte à outils des propriétés d'affichage destinées à l'élément de boîte à outils, pour créer un ou plusieurs composants lorsque ceux-ci doivent être utilisés et pour se sérialiser et se désérialiser pour assurer sa persistance dans la base de données de la boîte à outils.
Une instance de la classe ToolboxItem peut être configurée à l'aide d'un nom, d'une bitmap et du type à créer, sans créer une classe qui dérive de ToolboxItem. La classe ToolboxItem fournit également une classe de base pour les implémentations des éléments de boîte à outils personnalisés. Un ToolboxItem personnalisé peut créer plusieurs composants. Pour implémenter un élément de boîte à outils personnalisé, vous devez effectuer une dérivation de ToolboxItem et substituer les méthodes CreateComponentsCore, Serialize et Deserialize.
Les propriétés et méthodes suivantes doivent être configurées pour que ToolboxItem fonctionne correctement :
La propriété DisplayName spécifie l'étiquette de l'élément de boîte à outils lors de l'affichage dans une boîte à outils.
La propriété TypeName spécifie le nom qualifié complet du type de composant que l'élément crée. Si une classe dérivée crée plusieurs composants, la propriété TypeName peut ou non être utilisée, selon qu'une substitution de méthode CreateComponentsCore dépend ou non de la valeur de cette propriété.
La propriété AssemblyName spécifie l'assembly contenant le type d'un composant que l'élément crée.
La propriété Bitmap spécifie de manière facultative une image bitmap à afficher à côté du nom complet de l'élément de boîte à outils dans la boîte à outils.
La propriété Filter contient éventuellement les objets ToolboxItemFilterAttribute qui déterminent si l'élément de boîte à outils peut être utilisé sur un composant particulier.
La méthode CreateComponentsCore retourne l'instance ou les instances du composant à insérer à l'emplacement où cet outil est utilisé.
La méthode Serialize enregistre l'élément de boîte à outils dans un SerializationInfo spécifié.
La méthode Deserialize configure l'élément de boîte à outils à partir des informations d'état contenues dans le SerializationInfo spécifié.
La méthode Initialize configure l'élément de boîte à outils pour créer le type de composant spécifié, si la méthode CreateComponentsCore n'a pas été substituée pour se comporter différemment.
La propriété Locked indique si les propriétés de l'élément de boîte à outils peuvent être modifiées. Un élément de boîte à outils est généralement verrouillé une fois qu'il a été ajouté à une boîte à outils.
La méthode Lock verrouille un élément de boîte à outils.
La méthode CheckUnlocked lève une exception si la propriété Locked est true.
L'exemple de code suivant fournit un composant qui utilise l'interface IToolboxService pour ajouter un gestionnaire de format de données de type texte ou ToolboxItemCreatorCallback à la boîte à outils. Le délégué de rappel de créateur de données passe toutes les données textuelles collées dans la boîte à outils et déplacées vers un formulaire à un ToolboxItem personnalisé qui crée un TextBox contenant le texte.
Imports System
Imports System.ComponentModel
Imports System.ComponentModel.Design
Imports System.Drawing
Imports System.Drawing.Design
Imports System.Security.Permissions
Imports System.Windows.Forms
' Component that adds a "Text" data format ToolboxItemCreatorCallback
' to the Toolbox. This component uses a custom ToolboxItem that
' creates a TextBox containing the text data.
<PermissionSetAttribute(SecurityAction.Demand, Name:="FullTrust")> _
Public Class TextDataTextBoxComponent
Inherits System.ComponentModel.Component
Private creatorAdded As Boolean = False
Private ts As IToolboxService
Public Sub New()
End Sub
' ISite override to register TextBox creator
Public Overrides Property Site() As System.ComponentModel.ISite
Get
Return MyBase.Site
End Get
Set(ByVal Value As System.ComponentModel.ISite)
If (Value IsNot Nothing) Then
MyBase.Site = Value
If Not creatorAdded Then
AddTextTextBoxCreator()
End If
Else
If creatorAdded Then
RemoveTextTextBoxCreator()
End If
MyBase.Site = Value
End If
End Set
End Property
' Adds a "Text" data format creator to the toolbox that creates
' a textbox from a text fragment pasted to the toolbox.
Private Sub AddTextTextBoxCreator()
ts = CType(GetService(GetType(IToolboxService)), IToolboxService)
If (ts IsNot Nothing) Then
Dim textCreator As _
New ToolboxItemCreatorCallback(AddressOf Me.CreateTextBoxForText)
Try
ts.AddCreator( _
textCreator, _
"Text", _
CType(GetService(GetType(IDesignerHost)), IDesignerHost))
creatorAdded = True
Catch ex As Exception
MessageBox.Show(ex.ToString(), "Exception Information")
End Try
End If
End Sub
' Removes any "Text" data format creator from the toolbox.
Private Sub RemoveTextTextBoxCreator()
If (ts IsNot Nothing) Then
ts.RemoveCreator( _
"Text", _
CType(GetService(GetType(IDesignerHost)), IDesignerHost))
creatorAdded = False
End If
End Sub
' ToolboxItemCreatorCallback delegate format method to create
' the toolbox item.
Private Function CreateTextBoxForText( _
ByVal serializedObject As Object, _
ByVal format As String) As ToolboxItem
Dim o As New DataObject(CType(serializedObject, IDataObject))
Dim formats As String() = o.GetFormats()
If o.GetDataPresent("System.String", True) Then
Return New TextToolboxItem(CStr(o.GetData("System.String", True)))
End If
Return Nothing
End Function
Protected Overloads Overrides Sub Dispose(ByVal disposing As Boolean)
If creatorAdded Then
RemoveTextTextBoxCreator()
End If
End Sub
End Class
' Custom toolbox item creates a TextBox and sets its Text property
' to the constructor-specified text.
<PermissionSetAttribute(SecurityAction.Demand, Name:="FullTrust")> _
Public Class TextToolboxItem
Inherits System.Drawing.Design.ToolboxItem
Private [text] As String
Delegate Sub SetTextMethodHandler( _
ByVal c As Control, _
ByVal [text] As String)
Public Sub New(ByVal [text] As String)
Me.text = [text]
End Sub
' ToolboxItem.CreateComponentsCore override to create the TextBox
' and link a method to set its Text property.
<PermissionSetAttribute(SecurityAction.Demand, Name:="FullTrust")> _
Protected Overrides Function CreateComponentsCore(ByVal host As IDesignerHost) As IComponent()
Dim textbox As TextBox = CType(host.CreateComponent(GetType(TextBox)), TextBox)
' Because the designer resets the text of the textbox, use
' a SetTextMethodHandler to set the text to the value of
' the text data.
Dim c As Control = host.RootComponent
c.BeginInvoke( _
New SetTextMethodHandler(AddressOf OnSetText), _
New Object() {textbox, [text]})
Return New System.ComponentModel.IComponent() {textbox}
End Function
' Method to set the text property of a TextBox after it is initialized.
Private Sub OnSetText(ByVal c As Control, ByVal [text] As String)
c.Text = [text]
End Sub
End Class
using System;
using System.ComponentModel;
using System.ComponentModel.Design;
using System.Drawing;
using System.Drawing.Design;
using System.Security.Permissions;
using System.Windows.Forms;
namespace TextDataTextBoxComponent
{
// Component that adds a "Text" data format ToolboxItemCreatorCallback
// to the Toolbox. This component uses a custom ToolboxItem that
// creates a TextBox containing the text data.
[PermissionSet(SecurityAction.Demand, Name = "FullTrust")]
public class TextDataTextBoxComponent : Component
{
private bool creatorAdded = false;
private IToolboxService ts;
public TextDataTextBoxComponent()
{
}
// ISite override to register TextBox creator
public override System.ComponentModel.ISite Site
{
get
{
return base.Site;
}
set
{
if( value != null )
{
base.Site = value;
if (!creatorAdded)
{
AddTextTextBoxCreator();
}
}
else
{
if (creatorAdded)
{
RemoveTextTextBoxCreator();
}
base.Site = value;
}
}
}
// Adds a "Text" data format creator to the toolbox that creates
// a textbox from a text fragment pasted to the toolbox.
private void AddTextTextBoxCreator()
{
ts = (IToolboxService)GetService(typeof(IToolboxService));
if (ts != null)
{
ToolboxItemCreatorCallback textCreator =
new ToolboxItemCreatorCallback(this.CreateTextBoxForText);
try
{
ts.AddCreator(
textCreator,
"Text",
(IDesignerHost)GetService(typeof(IDesignerHost)));
creatorAdded = true;
}
catch(Exception ex)
{
MessageBox.Show(
ex.ToString(),
"Exception Information");
}
}
}
// Removes any "Text" data format creator from the toolbox.
private void RemoveTextTextBoxCreator()
{
if (ts != null)
{
ts.RemoveCreator(
"Text",
(IDesignerHost)GetService(typeof(IDesignerHost)));
creatorAdded = false;
}
}
// ToolboxItemCreatorCallback delegate format method to create
// the toolbox item.
private ToolboxItem CreateTextBoxForText(
object serializedObject,
string format)
{
DataObject o = new DataObject((IDataObject)serializedObject);
string[] formats = o.GetFormats();
if (o.GetDataPresent("System.String", true))
{
string toolboxText = (string)(o.GetData("System.String", true));
return (new TextToolboxItem(toolboxText));
}
return null;
}
protected override void Dispose(bool disposing)
{
if (creatorAdded)
{
RemoveTextTextBoxCreator();
}
}
}
// Custom toolbox item creates a TextBox and sets its Text property
// to the constructor-specified text.
[PermissionSet(SecurityAction.Demand, Name = "FullTrust")]
public class TextToolboxItem : ToolboxItem
{
private string text;
private delegate void SetTextMethodHandler(Control c, string text);
public TextToolboxItem(string text) : base()
{
this.text = text;
}
// ToolboxItem.CreateComponentsCore override to create the TextBox
// and link a method to set its Text property.
[PermissionSet(SecurityAction.Demand, Name="FullTrust")]
protected override IComponent[] CreateComponentsCore(IDesignerHost host)
{
System.Windows.Forms.TextBox textbox =
(TextBox)host.CreateComponent(typeof(TextBox));
// Because the designer resets the text of the textbox, use
// a SetTextMethodHandler to set the text to the value of
// the text data.
Control c = host.RootComponent as Control;
c.BeginInvoke(
new SetTextMethodHandler(OnSetText),
new object[] {textbox, text});
return new System.ComponentModel.IComponent[] { textbox };
}
// Method to set the text property of a TextBox after it is initialized.
private void OnSetText(Control c, string text)
{
c.Text = text;
}
}
}
#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::Drawing::Design;
using namespace System::Windows::Forms;
using namespace System::Security::Permissions;
namespace TextDataTextBoxComponent
{
// Custom toolbox item creates a TextBox and sets its Text property
// to the constructor-specified text.
[PermissionSetAttribute(SecurityAction::Demand, Name="FullTrust")]
public ref class TextToolboxItem: public ToolboxItem
{
private:
String^ text;
delegate void SetTextMethodHandler( Control^ c, String^ text );
public:
TextToolboxItem( String^ text )
: ToolboxItem()
{
this->text = text;
}
protected:
// ToolboxItem::CreateComponentsCore to create the TextBox
// and link a method to set its Text property.
virtual array<IComponent^>^ CreateComponentsCore( IDesignerHost^ host ) override
{
TextBox^ textbox = dynamic_cast<TextBox^>(host->CreateComponent( TextBox::typeid ));
// Because the designer resets the text of the textbox, use
// a SetTextMethodHandler to set the text to the value of
// the text data.
Control^ c = dynamic_cast<Control^>(host->RootComponent);
array<Object^>^temp0 = {textbox,text};
c->BeginInvoke( gcnew SetTextMethodHandler( this, &TextToolboxItem::OnSetText ), temp0 );
array<IComponent^>^temp1 = {textbox};
return temp1;
}
private:
// Method to set the text property of a TextBox after it is initialized.
void OnSetText( Control^ c, String^ text )
{
c->Text = text;
}
};
// Component that adds a "Text" data format ToolboxItemCreatorCallback
// to the Toolbox. This component uses a custom ToolboxItem that
// creates a TextBox containing the text data.
public ref class TextDataTextBoxComponent: public Component
{
private:
bool creatorAdded;
IToolboxService^ ts;
public:
TextDataTextBoxComponent()
{
creatorAdded = false;
}
property System::ComponentModel::ISite^ Site
{
// ISite to register TextBox creator
virtual System::ComponentModel::ISite^ get() override
{
return __super::Site;
}
virtual void set( System::ComponentModel::ISite^ value ) override
{
if ( value != nullptr )
{
__super::Site = value;
if ( !creatorAdded )
AddTextTextBoxCreator();
}
else
{
if ( creatorAdded )
RemoveTextTextBoxCreator();
__super::Site = value;
}
}
}
private:
// Adds a "Text" data format creator to the toolbox that creates
// a textbox from a text fragment pasted to the toolbox.
void AddTextTextBoxCreator()
{
ts = dynamic_cast<IToolboxService^>(GetService( IToolboxService::typeid ));
if ( ts != nullptr )
{
ToolboxItemCreatorCallback^ textCreator =
gcnew ToolboxItemCreatorCallback(
this,
&TextDataTextBoxComponent::CreateTextBoxForText );
try
{
ts->AddCreator(
textCreator,
"Text",
dynamic_cast<IDesignerHost^>(GetService( IDesignerHost::typeid )) );
creatorAdded = true;
}
catch ( Exception^ ex )
{
MessageBox::Show( ex->ToString(), "Exception Information" );
}
}
}
// Removes any "Text" data format creator from the toolbox.
void RemoveTextTextBoxCreator()
{
if ( ts != nullptr )
{
ts->RemoveCreator(
"Text",
dynamic_cast<IDesignerHost^>(GetService( IDesignerHost::typeid )) );
creatorAdded = false;
}
}
// ToolboxItemCreatorCallback delegate format method to create
// the toolbox item.
ToolboxItem^ CreateTextBoxForText( Object^ serializedObject, String^ format )
{
IDataObject^ o = gcnew DataObject(dynamic_cast<IDataObject^>(serializedObject));
if( o->GetDataPresent("System::String", true) )
{
String^ toolboxText = dynamic_cast<String^>(o->GetData( "System::String", true ));
return( gcnew TextToolboxItem( toolboxText ));
}
return nullptr;
}
public:
~TextDataTextBoxComponent()
{
if ( creatorAdded )
RemoveTextTextBoxCreator();
}
};
}
package TextDataTextBoxComponent;
import System.*;
import System.ComponentModel.*;
import System.ComponentModel.Design.*;
import System.Drawing.*;
import System.Drawing.Design.*;
import System.Windows.Forms.*;
// Component that adds a "Text" data format ToolboxItemCreatorCallback
// to the Toolbox that creates a custom ToolboxItem that
// creates a TextBox containing the text data.
public class TextDataTextBoxComponent extends System.ComponentModel.Component
{
private boolean creatorAdded = false;
private IToolboxService ts;
public TextDataTextBoxComponent()
{
}
// ISite override to register TextBox creator
/** @property
*/
public System.ComponentModel.ISite get_Site()
{
return super.get_Site();
}
/** @property
*/
public void set_Site(System.ComponentModel.ISite value)
{
if (value != null) {
super.set_Site(value);
if (!(creatorAdded)) {
AddTextTextBoxCreator();
}
}
else {
if (creatorAdded) {
RemoveTextTextBoxCreator();
}
super.set_Site(value);
}
}
// Adds a "Text" data format creator to the toolbox that creates
// a textbox from a text fragment pasted to the toolbox.
private void AddTextTextBoxCreator()
{
ts = (IToolboxService)GetService(IToolboxService.class.ToType());
if (ts != null) {
ToolboxItemCreatorCallback textCreator =
new ToolboxItemCreatorCallback(this.CreateTextBoxForText);
try {
ts.AddCreator(textCreator, "Text",
(IDesignerHost)GetService(IDesignerHost.class.ToType()));
creatorAdded = true;
}
catch (System.Exception ex) {
MessageBox.Show(ex.ToString(), "Exception Information");
}
}
}
// Removes any "Text" data format creator from the toolbox.
private void RemoveTextTextBoxCreator()
{
if (ts != null) {
ts.RemoveCreator("Text",
(IDesignerHost)GetService(IDesignerHost.class.ToType()));
creatorAdded = false;
}
}
// ToolboxItemCreatorCallback delegate format method to create
// the toolbox item.
private ToolboxItem CreateTextBoxForText(Object serializedObject,
String format)
{
DataObject o = new DataObject((IDataObject)serializedObject);
if (o.GetDataPresent("System.String", true))
{
String toolboxText = (String)(o.GetData("System.String", true));
return (new TextToolboxItem(toolboxText));
}
return null;
}
protected void Dispose(boolean disposing)
{
if (creatorAdded) {
RemoveTextTextBoxCreator();
}
}
}
// Custom toolbox item creates a TextBox and sets its Text property
// to the constructor-specified text.
public class TextToolboxItem extends System.Drawing.Design.ToolboxItem
{
private String text;
/** @delegate
*/
private delegate void SetTextMethodHandler(Control c, String text);
/** @attribute System.Security.Permissions.PermissionSet(
System.Security.Permissions.SecurityAction.Demand, Name = "FullTrust")
*/
public TextToolboxItem(String text)
{
this.text = text;
}
// ToolboxItem.CreateComponentsCore override to create the TextBox
// and link a method to set its Text property.
/** @attribute System.Security.Permissions.PermissionSet(
System.Security.Permissions.SecurityAction.Demand, Name = "FullTrust")
*/
protected System.ComponentModel.IComponent[] CreateComponentsCore(
System.ComponentModel.Design.IDesignerHost host)
{
System.Windows.Forms.TextBox textbox =
(TextBox)host.CreateComponent(TextBox.class.ToType());
// Because the designer resets the text of the textbox, use
// a SetTextMethodHandler to set the text to the value of
// the text data.
Control c = (Control)host.get_RootComponent();
c.BeginInvoke(new SetTextMethodHandler(OnSetText),
new Object[] { textbox, text });
return new System.ComponentModel.IComponent[] { textbox };
}
// Method to set the text property of a TextBox after it is initialized.
private void OnSetText(Control c, String text)
{
c.set_Text(text);
}
}
L'exemple de code suivant montre comment utiliser la classe ToolboxItem comme classe de base pour l'implémentation d'un élément de boîte à outils personnalisé.
Imports System
Imports System.Collections.Generic
Imports System.ComponentModel
Imports System.Drawing
Imports System.Drawing.Design
Imports System.Runtime.Serialization
Imports System.Text
Imports System.Windows.Forms
Public Class Form1
Inherits Form
Private components As System.ComponentModel.IContainer = Nothing
Friend WithEvents UserControl11 As UserControl1
Friend WithEvents label1 As System.Windows.Forms.Label
Public Sub New()
InitializeComponent()
End Sub
Private Sub InitializeComponent()
Me.label1 = New System.Windows.Forms.Label
Me.UserControl11 = New UserControl1
Me.SuspendLayout()
'
'label1
'
Me.label1.Location = New System.Drawing.Point(15, 16)
Me.label1.Name = "label1"
Me.label1.Size = New System.Drawing.Size(265, 62)
Me.label1.TabIndex = 0
Me.label1.Text = "Build the project and drop UserControl1" + _
" from the toolbox onto the form."
'
'UserControl11
'
Me.UserControl11.LabelText = "This is a custom user control. " + _
"The text you see here is provided by a custom too" + _
"lbox item when the user control is dropped on the form."
Me.UserControl11.Location = New System.Drawing.Point(74, 85)
Me.UserControl11.Name = "UserControl11"
Me.UserControl11.Padding = New System.Windows.Forms.Padding(6)
Me.UserControl11.TabIndex = 1
'
'Form1
'
Me.ClientSize = New System.Drawing.Size(292, 266)
Me.Controls.Add(Me.UserControl11)
Me.Controls.Add(Me.label1)
Me.Name = "Form1"
Me.Text = "Form1"
Me.ResumeLayout(False)
End Sub
Protected Overrides Sub Dispose(ByVal disposing As Boolean)
If disposing AndAlso (components IsNot Nothing) Then
components.Dispose()
End If
MyBase.Dispose(disposing)
End Sub
Shared Sub Main()
Application.EnableVisualStyles()
Application.Run(New Form1())
End Sub
End Class
' Configure this user control to have a custom toolbox item.
<ToolboxItem(GetType(MyToolboxItem))> _
Public Class UserControl1
Inherits UserControl
Private components As System.ComponentModel.IContainer = Nothing
Private label1 As System.Windows.Forms.Label
Public Sub New()
InitializeComponent()
End Sub
Public Property LabelText() As String
Get
Return label1.Text
End Get
Set(ByVal value As String)
label1.Text = Value
End Set
End Property
Private Sub InitializeComponent()
Me.label1 = New System.Windows.Forms.Label()
Me.SuspendLayout()
'
' label1
'
Me.label1.Dock = System.Windows.Forms.DockStyle.Fill
Me.label1.Location = New System.Drawing.Point(6, 6)
Me.label1.Name = "label1"
Me.label1.Size = New System.Drawing.Size(138, 138)
Me.label1.TabIndex = 0
Me.label1.Text = "This is a custom user control. " + _
"The text you see here is provided by a custom toolbox" + _
" item when the user control is dropped on the form." + _
vbCr + vbLf
Me.label1.TextAlign = System.Drawing.ContentAlignment.MiddleCenter
'
' UserControl1
'
Me.Controls.Add(label1)
Me.Name = "UserControl1"
Me.Padding = New System.Windows.Forms.Padding(6)
Me.ResumeLayout(False)
End Sub
Protected Overrides Sub Dispose(ByVal disposing As Boolean)
If disposing AndAlso (components IsNot Nothing) Then
components.Dispose()
End If
MyBase.Dispose(disposing)
End Sub
End Class
' Toolbox items must be serializable.
<Serializable()> _
Class MyToolboxItem
Inherits ToolboxItem
' The add components dialog in Visual Studio looks for a public
' constructor that takes a type.
Public Sub New(ByVal toolType As Type)
MyBase.New(toolType)
End Sub
' And you must provide this special constructor for serialization.
' If you add additional data to MyToolboxItem that you
' want to serialize, you may override Deserialize and
' Serialize methods to add that data.
Sub New(ByVal info As SerializationInfo, _
ByVal context As StreamingContext)
Deserialize(info, context)
End Sub
' Let's override the creation code and pop up a dialog.
Protected Overrides Function CreateComponentsCore( _
ByVal host As System.ComponentModel.Design.IDesignerHost, _
ByVal defaultValues As System.Collections.IDictionary) _
As IComponent()
' Get the string we want to fill in the custom
' user control. If the user cancels out of the dialog,
' return null or an empty array to signify that the
' tool creation was canceled.
Using d As New ToolboxItemDialog()
If d.ShowDialog() = DialogResult.OK Then
Dim [text] As String = d.CreationText
Dim comps As IComponent() = _
MyBase.CreateComponentsCore(host, defaultValues)
' comps will have a single component: our data type.
CType(comps(0), UserControl1).LabelText = [text]
Return comps
Else
Return Nothing
End If
End Using
End Function
End Class
Public Class ToolboxItemDialog
Inherits Form
Private components As System.ComponentModel.IContainer = Nothing
Private label1 As System.Windows.Forms.Label
Private textBox1 As System.Windows.Forms.TextBox
Private button1 As System.Windows.Forms.Button
Private button2 As System.Windows.Forms.Button
Public Sub New()
InitializeComponent()
End Sub
Private Sub InitializeComponent()
Me.label1 = New System.Windows.Forms.Label()
Me.textBox1 = New System.Windows.Forms.TextBox()
Me.button1 = New System.Windows.Forms.Button()
Me.button2 = New System.Windows.Forms.Button()
Me.SuspendLayout()
'
' label1
'
Me.label1.Location = New System.Drawing.Point(10, 9)
Me.label1.Name = "label1"
Me.label1.Size = New System.Drawing.Size(273, 43)
Me.label1.TabIndex = 0
Me.label1.Text = "Enter the text you would like" + _
" to have the user control populated with:"
'
' textBox1
'
Me.textBox1.AutoSize = False
Me.textBox1.Location = New System.Drawing.Point(10, 58)
Me.textBox1.Multiline = True
Me.textBox1.Name = "textBox1"
Me.textBox1.Size = New System.Drawing.Size(270, 67)
Me.textBox1.TabIndex = 1
Me.textBox1.Text = "This is a custom user control. " + _
"The text you see here is provided by a custom toolbox" + _
" item when the user control is dropped on the form."
'
' button1
'
Me.button1.DialogResult = System.Windows.Forms.DialogResult.OK
Me.button1.Location = New System.Drawing.Point(124, 131)
Me.button1.Name = "button1"
Me.button1.TabIndex = 2
Me.button1.Text = "OK"
'
' button2
'
Me.button2.DialogResult = System.Windows.Forms.DialogResult.Cancel
Me.button2.Location = New System.Drawing.Point(205, 131)
Me.button2.Name = "button2"
Me.button2.TabIndex = 3
Me.button2.Text = "Cancel"
'
' ToolboxItemDialog
'
Me.AcceptButton = Me.button1
Me.CancelButton = Me.button2
Me.ClientSize = New System.Drawing.Size(292, 162)
Me.ControlBox = False
Me.Controls.Add(button2)
Me.Controls.Add(button1)
Me.Controls.Add(textBox1)
Me.Controls.Add(label1)
Me.FormBorderStyle = _
System.Windows.Forms.FormBorderStyle.FixedDialog
Me.Name = "ToolboxItemDialog"
Me.Text = "ToolboxItemDialog"
Me.ResumeLayout(False)
End Sub
Public ReadOnly Property CreationText() As String
Get
Return textBox1.Text
End Get
End Property
Protected Overrides Sub Dispose(ByVal disposing As Boolean)
If disposing AndAlso (components IsNot Nothing) Then
components.Dispose()
End If
MyBase.Dispose(disposing)
End Sub
End Class
using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Drawing;
using System.Drawing.Design;
using System.Data;
using System.Runtime.Serialization;
using System.Text;
using System.Windows.Forms;
namespace CustomToolboxItem
{
public class Form1 : Form
{
private System.ComponentModel.IContainer components = null;
private UserControl1 userControl11;
private System.Windows.Forms.Label label1;
public Form1()
{
InitializeComponent();
}
private void InitializeComponent()
{
this.label1 = new System.Windows.Forms.Label();
this.userControl11 = new CustomToolboxItem.UserControl1();
this.SuspendLayout();
//
// label1
//
this.label1.Location = new System.Drawing.Point(15, 16);
this.label1.Name = "label1";
this.label1.Size = new System.Drawing.Size(265, 62);
this.label1.TabIndex = 0;
this.label1.Text = "Build the project and drop UserControl1 from the toolbox onto the form.";
//
// userControl11
//
this.userControl11.LabelText = "This is a custom user control. The text you see here is provided by a custom too" +
"lbox item when the user control is dropped on the form.";
this.userControl11.Location = new System.Drawing.Point(74, 81);
this.userControl11.Name = "userControl11";
this.userControl11.Padding = new System.Windows.Forms.Padding(6);
this.userControl11.Size = new System.Drawing.Size(150, 150);
this.userControl11.TabIndex = 1;
//
// Form1
//
this.ClientSize = new System.Drawing.Size(292, 266);
this.Controls.Add(this.userControl11);
this.Controls.Add(this.label1);
this.Name = "Form1";
this.Text = "Form1";
this.ResumeLayout(false);
}
protected override void Dispose(bool disposing)
{
if (disposing && (components != null))
{
components.Dispose();
}
base.Dispose(disposing);
}
static void Main()
{
Application.EnableVisualStyles();
Application.Run(new Form1());
}
}
// Configure this user control to have a custom toolbox item.
[ToolboxItem(typeof(MyToolboxItem))]
public class UserControl1 : UserControl
{
private System.ComponentModel.IContainer components = null;
private System.Windows.Forms.Label label1;
public UserControl1()
{
InitializeComponent();
}
public string LabelText
{
get
{
return label1.Text;
}
set
{
label1.Text = value;
}
}
private void InitializeComponent()
{
this.label1 = new System.Windows.Forms.Label();
this.SuspendLayout();
//
// label1
//
this.label1.Dock = System.Windows.Forms.DockStyle.Fill;
this.label1.Location = new System.Drawing.Point(6, 6);
this.label1.Name = "label1";
this.label1.Size = new System.Drawing.Size(138, 138);
this.label1.TabIndex = 0;
this.label1.Text = "This is a custom user control. " +
"The text you see here is provided by a custom toolbox" +
" item when the user control is dropped on the form.\r\n";
this.label1.TextAlign =
System.Drawing.ContentAlignment.MiddleCenter;
//
// UserControl1
//
this.Controls.Add(this.label1);
this.Name = "UserControl1";
this.Padding = new System.Windows.Forms.Padding(6);
this.ResumeLayout(false);
}
protected override void Dispose(bool disposing)
{
if (disposing && (components != null))
{
components.Dispose();
}
base.Dispose(disposing);
}
}
// Toolbox items must be serializable.
[Serializable]
class MyToolboxItem : ToolboxItem
{
// The add components dialog in Visual Studio looks for a public
// constructor that takes a type.
public MyToolboxItem(Type toolType)
: base(toolType)
{
}
// And you must provide this special constructor for serialization.
// If you add additional data to MyToolboxItem that you
// want to serialize, you may override Deserialize and
// Serialize methods to add that data.
MyToolboxItem(SerializationInfo info, StreamingContext context)
{
Deserialize(info, context);
}
// Let's override the creation code and pop up a dialog.
protected override IComponent[] CreateComponentsCore(
System.ComponentModel.Design.IDesignerHost host,
System.Collections.IDictionary defaultValues)
{
// Get the string we want to fill in the custom
// user control. If the user cancels out of the dialog,
// return null or an empty array to signify that the
// tool creation was canceled.
using (ToolboxItemDialog d = new ToolboxItemDialog())
{
if (d.ShowDialog() == DialogResult.OK)
{
string text = d.CreationText;
IComponent[] comps =
base.CreateComponentsCore(host, defaultValues);
// comps will have a single component: our data type.
((UserControl1)comps[0]).LabelText = text;
return comps;
}
else
{
return null;
}
}
}
}
public class ToolboxItemDialog : Form
{
private System.ComponentModel.IContainer components = null;
private System.Windows.Forms.Label label1;
private System.Windows.Forms.TextBox textBox1;
private System.Windows.Forms.Button button1;
private System.Windows.Forms.Button button2;
public ToolboxItemDialog()
{
InitializeComponent();
}
private void InitializeComponent()
{
this.label1 = new System.Windows.Forms.Label();
this.textBox1 = new System.Windows.Forms.TextBox();
this.button1 = new System.Windows.Forms.Button();
this.button2 = new System.Windows.Forms.Button();
this.SuspendLayout();
//
// label1
//
this.label1.Location = new System.Drawing.Point(10, 9);
this.label1.Name = "label1";
this.label1.Size = new System.Drawing.Size(273, 43);
this.label1.TabIndex = 0;
this.label1.Text = "Enter the text you would like" +
" to have the user control populated with:";
//
// textBox1
//
this.textBox1.AutoSize = false;
this.textBox1.Location = new System.Drawing.Point(10, 58);
this.textBox1.Multiline = true;
this.textBox1.Name = "textBox1";
this.textBox1.Size = new System.Drawing.Size(270, 67);
this.textBox1.TabIndex = 1;
this.textBox1.Text = "This is a custom user control. " +
"The text you see here is provided by a custom toolbox" +
" item when the user control is dropped on the form.";
//
// button1
//
this.button1.DialogResult = System.Windows.Forms.DialogResult.OK;
this.button1.Location = new System.Drawing.Point(124, 131);
this.button1.Name = "button1";
this.button1.TabIndex = 2;
this.button1.Text = "OK";
//
// button2
//
this.button2.DialogResult = System.Windows.Forms.DialogResult.Cancel;
this.button2.Location = new System.Drawing.Point(205, 131);
this.button2.Name = "button2";
this.button2.TabIndex = 3;
this.button2.Text = "Cancel";
//
// ToolboxItemDialog
//
this.AcceptButton = this.button1;
this.CancelButton = this.button2;
this.ClientSize = new System.Drawing.Size(292, 162);
this.ControlBox = false;
this.Controls.Add(this.button2);
this.Controls.Add(this.button1);
this.Controls.Add(this.textBox1);
this.Controls.Add(this.label1);
this.FormBorderStyle =
System.Windows.Forms.FormBorderStyle.FixedDialog;
this.Name = "ToolboxItemDialog";
this.Text = "ToolboxItemDialog";
this.ResumeLayout(false);
}
public string CreationText
{
get
{
return textBox1.Text;
}
}
protected override void Dispose(bool disposing)
{
if (disposing && (components != null))
{
components.Dispose();
}
base.Dispose(disposing);
}
}
}
System..::.Object
System.Drawing.Design..::.ToolboxItem
System.Web.UI.Design..::.WebControlToolboxItem
System.Workflow.ComponentModel.Design..::.ActivityToolboxItem
Tous les membres static (Shared en Visual Basic) publics de ce type sont thread-safe. Il n'est pas garanti que les membres d'instance soient thread-safe.
Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professionnel Édition x64, Windows XP Starter Edition, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98
Le .NET Framework et le .NET Compact Framework ne prennent pas en charge toutes les versions de chaque plateforme. Pour obtenir la liste des versions prises en charge, consultez Configuration requise du .NET Framework.
.NET Framework
Pris en charge dans : 3.5, 3.0, 2.0, 1.1, 1.0
Référence