ConnectionTool Class
DomainClass ConnectionTool Defines a tool on the toolbox for making a connection.
Inheritance Hierarchy
System.Object
Microsoft.VisualStudio.Modeling.ModelElement
Microsoft.VisualStudio.Modeling.DslDefinition.DomainElement
Microsoft.VisualStudio.Modeling.DslDefinition.Tool
Microsoft.VisualStudio.Modeling.DslDefinition.ConnectionTool
Namespace: Microsoft.VisualStudio.Modeling.DslDefinition
Assembly: Microsoft.VisualStudio.Modeling.Sdk.DslDefinition.10.0 (in Microsoft.VisualStudio.Modeling.Sdk.DslDefinition.10.0.dll)
Syntax
'Declaration
<ValidationStateAttribute(ValidationState.Enabled)> _
<DescriptionResourceAttribute("Microsoft.VisualStudio.Modeling.DslDefinition.ConnectionTool.Description", _
GetType(DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")> _
<DomainObjectIdAttribute("b69f29d5-23ff-4a67-909e-541ab2d5ac71")> _
<DisplayNameResourceAttribute("Microsoft.VisualStudio.Modeling.DslDefinition.ConnectionTool.DisplayName", _
GetType(DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")> _
<ValidationStateAttribute(ValidationState.Enabled)> _
<DomainModelOwnerAttribute(GetType(DslDefinitionModelDomainModel))> _
<CLSCompliantAttribute(True)> _
Public NotInheritable Class ConnectionTool _
Inherits Tool
[ValidationStateAttribute(ValidationState.Enabled)]
[DescriptionResourceAttribute("Microsoft.VisualStudio.Modeling.DslDefinition.ConnectionTool.Description",
typeof(DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")]
[DomainObjectIdAttribute("b69f29d5-23ff-4a67-909e-541ab2d5ac71")]
[DisplayNameResourceAttribute("Microsoft.VisualStudio.Modeling.DslDefinition.ConnectionTool.DisplayName",
typeof(DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")]
[ValidationStateAttribute(ValidationState.Enabled)]
[DomainModelOwnerAttribute(typeof(DslDefinitionModelDomainModel))]
[CLSCompliantAttribute(true)]
public sealed class ConnectionTool : Tool
[ValidationStateAttribute(ValidationState::Enabled)]
[DescriptionResourceAttribute(L"Microsoft.VisualStudio.Modeling.DslDefinition.ConnectionTool.Description",
typeof(DslDefinitionModelDomainModel), L"Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")]
[DomainObjectIdAttribute(L"b69f29d5-23ff-4a67-909e-541ab2d5ac71")]
[DisplayNameResourceAttribute(L"Microsoft.VisualStudio.Modeling.DslDefinition.ConnectionTool.DisplayName",
typeof(DslDefinitionModelDomainModel), L"Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")]
[ValidationStateAttribute(ValidationState::Enabled)]
[DomainModelOwnerAttribute(typeof(DslDefinitionModelDomainModel))]
[CLSCompliantAttribute(true)]
public ref class ConnectionTool sealed : public Tool
[<Sealed>]
[<ValidationStateAttribute(ValidationState.Enabled)>]
[<DescriptionResourceAttribute("Microsoft.VisualStudio.Modeling.DslDefinition.ConnectionTool.Description",
typeof(DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")>]
[<DomainObjectIdAttribute("b69f29d5-23ff-4a67-909e-541ab2d5ac71")>]
[<DisplayNameResourceAttribute("Microsoft.VisualStudio.Modeling.DslDefinition.ConnectionTool.DisplayName",
typeof(DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")>]
[<ValidationStateAttribute(ValidationState.Enabled)>]
[<DomainModelOwnerAttribute(typeof(DslDefinitionModelDomainModel))>]
[<CLSCompliantAttribute(true)>]
type ConnectionTool =
class
inherit Tool
end
public final class ConnectionTool extends Tool
The ConnectionTool type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Public method") |
ConnectionTool(Partition, array<PropertyAssignment[]) | Constructor |
|
ConnectionTool(Store, array<PropertyAssignment[]) | Constructor |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
Caption | Gets or sets the value of Caption domain property. Caption for the tool as displayed in the UI. (Inherited from Tool.) |
|
ConnectionBuilder | Gets or sets ConnectionBuilder. Connection builder which the tool uses to make a connection. |
|
HelpKeyword | Gets or sets the value of HelpKeyword domain property. Optional keyword used to index F1 help for the tool. (Inherited from Tool.) |
|
Id | Gets the ID of the element. (Inherited from ModelElement.) |
|
IsActive | Gets the IsActive flag and verifies to see whether the element is active. (Inherited from ModelElement.) |
|
IsCaptionTracking | Gets or sets the value of IsCaptionTracking domain property. If True, the Caption property tracks other data in the DSL definition. (Inherited from Tool.) |
|
IsDeleted | Gets the IsDeleted flag and checks to see whether the element has been deleted from the model. (Inherited from ModelElement.) |
|
IsDeleting | Gets the IsDeleting flag and verifies whether the element is currently being deleted from the model. (Inherited from ModelElement.) |
|
IsHelpKeywordTracking | Gets or sets the value of IsHelpKeywordTracking domain property. If True, the HelpKeyword property tracks other data in the DSL definition. (Inherited from Tool.) |
|
IsTooltipTracking | Gets or sets the value of IsTooltipTracking domain property. If True, the Tooltip property tracks other data in the DSL definition. (Inherited from Tool.) |
|
Name | Gets or sets the value of Name domain property. Name of the tool, used for reference. (Inherited from Tool.) |
|
Notes | Gets or sets the value of Notes domain property. Informal notes associated with this element. (Inherited from DomainElement.) |
|
Partition | Gets or sets the Partition that contains the element. (Inherited from ModelElement.) |
|
ReversesDirection | Gets or sets the value of ReversesDirection domain property. If True, the first element selected is treated as the target of the connection and the second element as the source. |
|
SourceCursorIcon | Gets or sets the value of SourceCursorIcon domain property. Icon used for the cursor of the tool before the first element is selected. |
|
Store | Gets the Store that contains the element. (Inherited from ModelElement.) |
|
TargetCursorIcon | Gets or sets the value of TargetCursorIcon domain property. Icon used for the cursor of the tool after the first element is selected. |
|
ToolboxIcon | Gets or sets the value of ToolboxIcon domain property. Relative file path of icon displayed in the toolbox for this tool. (Inherited from Tool.) |
|
ToolboxTab | Gets or sets ToolboxTab. Toolbox tab defining the tool. (Inherited from Tool.) |
|
Tooltip | Gets or sets the value of Tooltip domain property. Text used for the tooltip. (Inherited from Tool.) |
Top
Methods
| Name | Description | |
|---|---|---|
.gif "Protected method") |
CanMerge | Verifies whether a source element can be added to this element. (Inherited from ModelElement.) |
|
ChooseMergeTarget(ElementGroup) | Selects a target element to accept as its child an element that the user wants to copy, drag, or create. (Inherited from ModelElement.) |
|
ChooseMergeTarget(ElementGroupPrototype) | Selects a target element to accept as its child an element that the user wants to copy, drag, or create. (Inherited from ModelElement.) |
|
Copy() | Creates a copy of the element in the model. (Inherited from ModelElement.) |
|
Copy(IEnumerable<Guid>) | Creates a copy of the element and its child links and elements. (Inherited from ModelElement.) |
|
Delete() | Deletes an element from the model. (Inherited from ModelElement.) |
|
Delete(array<Guid[]) | Deletes an element from the model. (Inherited from ModelElement.) |
|
Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
|
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
|
GetDomainClass | Gets the most-derived domain class for this element. (Inherited from ModelElement.) |
|
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
|
GetRoleCollection<TCollection, TElement>(Guid) | Gets or creates the linked element collection (Inherited from ModelElement.) |
|
GetType | Gets the Type of the current instance. (Inherited from Object.) |
|
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
|
MergeConfigure | Allows the model element to configure itself immediately after the Merge process has related it to the target element. (Inherited from ModelElement.) |
|
MergeDisconnect | Disconnects a source element from a target element. (Inherited from ModelElement.) |
|
MergeRelate | Creates a relationship between this target element and the specified source element. (Inherited from ModelElement.) |
|
OnCopy | Called when this element has been created as a copy of another element. (Inherited from ModelElement.) |
|
OnDeleted | Called when this element has been deleted from the model. (Inherited from ModelElement.) |
|
OnDeleting | Called when this element is about to be deleted. (Inherited from ModelElement.) |
|
OnResurrected | Called when this element has been added back to a model. (Inherited from ModelElement.) |
|
OnRolePlayerPositionChanged | Called when the position of a role has changed. (Inherited from ModelElement.) |
|
OnRolePlayerPositionChanging | Called when a role player position is about to change. (Inherited from ModelElement.) |
|
ToString | Returns a string that represents the current object. (Inherited from Object.) |
Top
Extension Methods
| Name | Description | |
|---|---|---|
.gif "Public Extension Method") |
AddExtension(Guid) | Overloaded. Extend this ModelElement with newly instantiated extension of the identified domain type. An InvalidOperationException will be thrown if the element already has an extension of that type. (Defined by ModelElementExtensionMethods.) |
|
AddExtension(Type) | Overloaded. Extend this ModelElement with a newly instantiated extension of the specified type. An InvalidOperationException will be thrown if the element already has an extension of that type. (Defined by ModelElementExtensionMethods.) |
|
AddExtension(DomainClassInfo) | Overloaded. Extend this ModelElement with a newly instantiated extension of the specified domain type. An InvalidOperationException will be thrown if the element already has an extension of that type. (Defined by ModelElementExtensionMethods.) |
|
AddExtension(ExtensionElement) | Overloaded. Extend this ModelElement with a specific extension. An InvalidOperationException will be thrown if the element already has an extension of the same type. (Defined by ModelElementExtensionMethods.) |
|
AddExtension<T>() | Overloaded. Extend this ModelElement with a newly instantiated extension of a particular type. An InvalidOperationException will be thrown if the element already has an extension of the same type. (Defined by ModelElementExtensionMethods.) |
|
CanDelete | Deletes the element from the model. (Defined by ImmutabilityExtensionMethods.) |
|
GetAllExtensions | Return an enumerable that performs a breadth first traversal across the tree of extension elements embedded in this ModelElement. (Defined by ModelElementExtensionMethods.) |
|
GetBaseElement | Returns the root of the virtual MEL in which the specified ModelElement is participating. (Defined by ModelElementExtensionMethods.) |
|
GetExtension(Guid) | Overloaded. (Defined by ModelElementExtensionMethods.) |
|
GetExtension(Type) | Overloaded. Get the ExtensionElement of the specified type from the available extensions of this ModelElement. If the element has no such extension then an InvalidOperationException will be raised. (Defined by ModelElementExtensionMethods.) |
|
GetExtension(DomainClassInfo) | Overloaded. (Defined by ModelElementExtensionMethods.) |
|
GetExtension<T>() | Overloaded. Get the ExtensionElement of the specified type from the available extensions of this ModelElement. If the element has no such extension then an InvalidOperationException will be raised. (Defined by ModelElementExtensionMethods.) |
|
GetLocks | Get the lock flags for this element. This will include any locks enabled on the Partition containing the element. (Defined by ImmutabilityExtensionMethods.) |
|
IsExtendedBy(Guid) | Overloaded. Query whether this ModelElement is currently extended by an ExtensionElement of a particular type. (Defined by ModelElementExtensionMethods.) |
|
IsExtendedBy(Type) | Overloaded. Query whether this ModelElement is currently extended by an ExtensionElement of a particular type. (Defined by ModelElementExtensionMethods.) |
|
IsExtendedBy(DomainClassInfo) | Overloaded. Query whether this ModelElement is currently extended by an ExtensionElement of a particular type. (Defined by ModelElementExtensionMethods.) |
|
IsLocked | Test whether this element has any of a specified set of locks (Defined by ImmutabilityExtensionMethods.) |
|
RemoveExtension(Type) | Overloaded. Remove any extension of this ModelElement that is of a particular type. (Defined by ModelElementExtensionMethods.) |
|
RemoveExtension(Guid) | Overloaded. Remove any extension of the specified ModelElement that is of a particular type. (Defined by ModelElementExtensionMethods.) |
|
RemoveExtension(DomainClassInfo) | Overloaded. Remove any extension of the specified ModelElement that is of a particular type. (Defined by ModelElementExtensionMethods.) |
|
RemoveExtension(ExtensionElement) | Overloaded. Remove a specified ExtensionElement from the extensions of this ModelElement. (Defined by ModelElementExtensionMethods.) |
|
SetLocks | Set the lock flags of this element (Defined by ImmutabilityExtensionMethods.) |
|
TryGetExtension(Guid) | Overloaded. (Defined by ModelElementExtensionMethods.) |
|
TryGetExtension(Type) | Overloaded. (Defined by ModelElementExtensionMethods.) |
|
TryGetExtension(DomainClassInfo) | Overloaded. (Defined by ModelElementExtensionMethods.) |
|
TryGetExtension<T>() | Overloaded. Get the ExtensionElement of the specified type from the available extensions of this ModelElement. If this element has no such extension then the result will be null. (Defined by ModelElementExtensionMethods.) |
Top
Fields
| Name | Description | |
|---|---|---|
.gif "Public field") .gif "Static member") |
DomainClassId | ConnectionTool domain class Id. |
|
ReversesDirectionDomainPropertyId | ReversesDirection domain property Id. |
|
SourceCursorIconDomainPropertyId | SourceCursorIcon domain property Id. |
|
TargetCursorIconDomainPropertyId | TargetCursorIcon domain property Id. |
Top
Explicit Interface Implementations
| Name | Description | |
|---|---|---|
.gif "Explicit interface implemetation") .gif "Private method") |
IMergeElements.CanMerge | Returns true if this element can merge with the content of the prototype. (Inherited from ModelElement.) |
|
IMergeElements.ChooseMergeTarget(ElementGroup) | (Inherited from ModelElement.) |
|
IMergeElements.ChooseMergeTarget(ElementGroupPrototype) | (Inherited from ModelElement.) |
|
IMergeElements.MergeConfigure | (Inherited from ModelElement.) |
|
IMergeElements.MergeDisconnect | (Inherited from ModelElement.) |
|
IMergeElements.MergeRelate | (Inherited from ModelElement.) |
Top
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.