Freigeben über

ModelingToolboxItem Class

  • Artikel

Represents a toolbox item generated in the Domain-Specific Language Tools (DSL Tools).

Inheritance Hierarchy

System.Object
  System.Drawing.Design.ToolboxItem
    Microsoft.VisualStudio.Modeling.Design.ModelingToolboxItemBase
      Microsoft.VisualStudio.Modeling.Design.ModelingToolboxItem

Namespace:  Microsoft.VisualStudio.Modeling.Design
Assembly:  Microsoft.VisualStudio.Modeling.Sdk.10.0 (in Microsoft.VisualStudio.Modeling.Sdk.10.0.dll)

Syntax

'Declaration
<SerializableAttribute> _
<PermissionSetAttribute(SecurityAction.LinkDemand, Name := "FullTrust")> _
<PermissionSetAttribute(SecurityAction.InheritanceDemand, Name := "FullTrust")> _
Public Class ModelingToolboxItem _
    Inherits ModelingToolboxItemBase

[SerializableAttribute]
[PermissionSetAttribute(SecurityAction.LinkDemand, Name = "FullTrust")]
[PermissionSetAttribute(SecurityAction.InheritanceDemand, Name = "FullTrust")]
public class ModelingToolboxItem : ModelingToolboxItemBase

[SerializableAttribute]
[PermissionSetAttribute(SecurityAction::LinkDemand, Name = L"FullTrust")]
[PermissionSetAttribute(SecurityAction::InheritanceDemand, Name = L"FullTrust")]
public ref class ModelingToolboxItem : public ModelingToolboxItemBase

[<SerializableAttribute>]
[<PermissionSetAttribute(SecurityAction.LinkDemand, Name = "FullTrust")>]
[<PermissionSetAttribute(SecurityAction.InheritanceDemand, Name = "FullTrust")>]
type ModelingToolboxItem =  
    class
        inherit ModelingToolboxItemBase
    end

public class ModelingToolboxItem extends ModelingToolboxItemBase

The ModelingToolboxItem type exposes the following members.

Constructors

  Name Description
Protected method ModelingToolboxItem(SerializationInfo, StreamingContext) Initializes a new instance of the ModelingToolboxItem class from serialized data.
Public method ModelingToolboxItem(String, Int32, String, Bitmap, String, String, String, String, ElementGroupPrototype, ICollection) Initializes a new instance of the ModelingToolboxItem class from the specified information.

Top

Properties

  Name Description
Public property AssemblyName Gets or sets the name of the assembly that contains the type or types that the toolbox item creates. (Inherited from ToolboxItem.)
Public property Bitmap Gets or sets a bitmap to represent the toolbox item in the toolbox. (Inherited from ToolboxItem.)
Public property Company Gets or sets the company name for this ToolboxItem. (Inherited from ToolboxItem.)
Public property ComponentType Gets the ComponentType string that is shown in the tooltip for this item. (Inherited from ModelingToolboxItemBase.)
Public property ContextSensitiveHelpKeyword Gets context sensitive help keyword of the toolbox item. Should NOT be localized. (Inherited from ModelingToolboxItemBase.)
Public property DependentAssemblies Gets or sets the AssemblyName for the toolbox item. (Inherited from ToolboxItem.)
Public property Description Gets or sets the description for this ToolboxItem. (Inherited from ToolboxItem.)
Public property DisplayName Gets or sets the display name for the toolbox item. (Inherited from ToolboxItem.)
Public property Filter Gets or sets the filter that determines whether the toolbox item can be used on a destination component. (Inherited from ToolboxItem.)
Public property Id Gets the unique identified of this toolbox item. (Inherited from ModelingToolboxItemBase.)
Public property IsTransient Gets a value indicating whether the toolbox item is transient. (Inherited from ToolboxItem.)
Public property Locked Gets a value indicating whether the ToolboxItem is currently locked. (Inherited from ToolboxItem.)
Public property Position Gets the suggested position of the toolbox item. (Inherited from ModelingToolboxItemBase.)
Public property Properties Gets a dictionary of properties. (Inherited from ToolboxItem.)
Public property Prototype Gets or sets the information required to create an ElementGroup for this toolbox item.
Public property TabName Gets the name of the toolbox tab to contain this item. Should be localized. (Inherited from ModelingToolboxItemBase.)
Public property TabNameId Gets non-localized name Id of the toolbox tab to contain this item. Must NOT be localized. (Inherited from ModelingToolboxItemBase.)
Public property TypeName Gets or sets the fully qualified name of the type of IComponent that the toolbox item creates when invoked. (Inherited from ToolboxItem.)
Public property Version Gets the version for this ToolboxItem. (Inherited from ToolboxItem.)

Top

Methods

  Name Description
Protected method CheckUnlocked Throws an exception if the toolbox item is currently locked. (Inherited from ToolboxItem.)
Public method CreateComponents() Creates the components that the toolbox item is configured to create. (Inherited from ToolboxItem.)
Public method CreateComponents(IDesignerHost) Creates the components that the toolbox item is configured to create, using the specified designer host. (Inherited from ToolboxItem.)
Public method CreateComponents(IDesignerHost, IDictionary) Creates the components that the toolbox item is configured to create, using the specified designer host and default values. (Inherited from ToolboxItem.)
Protected method CreateComponentsCore(IDesignerHost) Creates a component or an array of components when the toolbox item is invoked. (Inherited from ToolboxItem.)
Protected method CreateComponentsCore(IDesignerHost, IDictionary) Creates an array of components when the toolbox item is invoked. (Inherited from ToolboxItem.)
Protected method Deserialize Loads the state of the toolbox item from the specified serialization information object. (Overrides ModelingToolboxItemBase.Deserialize(SerializationInfo, StreamingContext).)
Public method Equals Determines whether two ModelingToolboxItemBase instances are equal. (Inherited from ModelingToolboxItemBase.)
Protected method FilterPropertyValue Filters a property value before returning it. (Inherited from ToolboxItem.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Returns the hash code for this instance. (Inherited from ModelingToolboxItemBase.)
Public method GetType() Gets the Type of the current instance. (Inherited from Object.)
Public method GetType(IDesignerHost) Enables access to the type associated with the toolbox item. (Inherited from ToolboxItem.)
Protected method GetType(IDesignerHost, AssemblyName, String, Boolean) Creates an instance of the specified type, optionally using a specified designer host and assembly name. (Inherited from ToolboxItem.)
Public method Initialize Initializes the current toolbox item with the specified type to create. (Inherited from ToolboxItem.)
Public method Lock Locks the toolbox item and prevents changes to its properties. (Inherited from ToolboxItem.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method OnComponentsCreated Raises the ComponentsCreated event. (Inherited from ToolboxItem.)
Protected method OnComponentsCreating Raises the ComponentsCreating event. (Inherited from ToolboxItem.)
Protected method Serialize Saves the state of the toolbox item to the specified serialization information object. (Overrides ModelingToolboxItemBase.Serialize(SerializationInfo, StreamingContext).)
Public method ToString Returns a String that represents the current ToolboxItem. (Inherited from ToolboxItem.)
Protected method ValidatePropertyType Validates that an object is of a given type. (Inherited from ToolboxItem.)
Protected method ValidatePropertyValue Validates a property before it is assigned to the property dictionary. (Inherited from ToolboxItem.)

Top

Events

  Name Description
Public event ComponentsCreated Occurs immediately after components are created. (Inherited from ToolboxItem.)
Public event ComponentsCreating Occurs when components are about to be created. (Inherited from ToolboxItem.)

Top

Fields

  Name Description
Public fieldStatic member ToolboxContextOrigin Specifies the key that indicates that a copy operation originated in the Toolbox. This field is constant.

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method ISerializable.GetObjectData For a description of this member, see the GetObjectData method. (Inherited from ToolboxItem.)

Top

Remarks

This class provides standard toolbox item information, and also information to add to the diagram when a user of the DSL drags an item from the toolbox to the design surface. The DSL Tools generate these toolbox items from the DSL definition. You can create additional toolbox items in your code.

Thread Safety

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

See Also

Reference

Microsoft.VisualStudio.Modeling.Design Namespace