This documentation is archived and is not being maintained.

ToolboxItemContainer Class

Encapsulates a ToolboxItem.


Namespace:  System.Drawing.Design
Assembly:  System.Drawing.Design (in System.Drawing.Design.dll)

public class ToolboxItemContainer : ISerializable

The ToolboxItemContainer type exposes the following members.

Public methodToolboxItemContainer(IDataObject)Initializes a new instance of the ToolboxItemContainer class from a System.Windows.Forms.IDataObject.
Public methodToolboxItemContainer(ToolboxItem)Initializes a new instance of the ToolboxItemContainer class from a ToolboxItem.
Protected methodToolboxItemContainer(SerializationInfo, StreamingContext)Initializes a new instance of the ToolboxItemContainer class from a serialization stream.

Public propertyIsCreatedGets a value indicating whether the underlying toolbox item has been deserialized.
Public propertyIsTransientGets a value indicating if the ToolboxItem contained in the ToolboxItemContainer is transient.
Public propertyToolboxDataGets an System.Windows.Forms.IDataObject that describes this ToolboxItemContainer.

Public methodEqualsDetermines whether two ToolboxItemContainer instances are equal. (Overrides Object.Equals(Object).)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetFilterReturns a collection of ToolboxItemFilterAttribute objects that represent the current filter for the ToolboxItem.
Public methodGetHashCodeReturns the hash code for this instance. (Overrides Object.GetHashCode().)
Protected methodGetObjectDataSaves the serialization state for the object.
Public methodGetToolboxItemReturns the ToolboxItem contained in the ToolboxItemContainer.
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodUpdateFilterMerges the container's filter with the filter from the given item.

Explicit interface implemetationPrivate methodISerializable.GetObjectDataFor a description of this member, see the GetObjectData method.

ToolboxItemContainer is a simple class that encapsulates a ToolboxItem for efficiency. By having a single class that is always loaded, you can defer the loading of the ToolboxItem until it is needed. Because new classes can be derived from ToolboxItem, you could load a ToolboxItem that could, in turn, load an assembly that is not already in memory. For a large collection of ToolboxItem objects, this could cause a large number of assemblies to be loaded, which decreases performance. Instead, the toolbox service deals only with ToolboxItemContainer objects and retrieves their contained ToolboxItem only when necessary.

The ToolboxItemContainer is designed to hold any cached data from the ToolboxItem. The default implementation only holds the filter of the ToolboxItem, but deriving classes may choose to cache the name, image, and other information. ToolboxItemContainer objects support two forms of serialization: they can be serialized through standard runtime serialization, and they can also load and save themselves from a System.Windows.Forms.IDataObject. The former provides a very easy way to save ToolboxItemContainer objects to a persistent storage. The latter provides a way to integrate ToolboxItemContainer objects with mixed data storage formats.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.