SwimLane Class

DomainClass SwimLane Defines a swimlane.

Inheritance Hierarchy

System.Object
  Microsoft.VisualStudio.Modeling.ModelElement
    Microsoft.VisualStudio.Modeling.DslDefinition.DomainElement
      Microsoft.VisualStudio.Modeling.DslDefinition.AttributedDomainElement
        Microsoft.VisualStudio.Modeling.DslDefinition.NamedDomainElement
          Microsoft.VisualStudio.Modeling.DslDefinition.DomainClass
            Microsoft.VisualStudio.Modeling.DslDefinition.DiagramElement
              Microsoft.VisualStudio.Modeling.DslDefinition.BaseShape
                Microsoft.VisualStudio.Modeling.DslDefinition.SwimLane

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

Syntax

'Declaration
<DomainModelOwnerAttribute(GetType(DslDefinitionModelDomainModel))> _
<DomainObjectIdAttribute("eef3cdf6-7211-4458-afc4-24baf956524e")> _
<CLSCompliantAttribute(True)> _
<DisplayNameResourceAttribute("Microsoft.VisualStudio.Modeling.DslDefinition.SwimLane.DisplayName",  _
    GetType(DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")> _
<DescriptionResourceAttribute("Microsoft.VisualStudio.Modeling.DslDefinition.SwimLane.Description",  _
    GetType(DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")> _
Public NotInheritable Class SwimLane _
    Inherits BaseShape

[DomainModelOwnerAttribute(typeof(DslDefinitionModelDomainModel))]
[DomainObjectIdAttribute("eef3cdf6-7211-4458-afc4-24baf956524e")]
[CLSCompliantAttribute(true)]
[DisplayNameResourceAttribute("Microsoft.VisualStudio.Modeling.DslDefinition.SwimLane.DisplayName", 
    typeof(DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")]
[DescriptionResourceAttribute("Microsoft.VisualStudio.Modeling.DslDefinition.SwimLane.Description", 
    typeof(DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")]
public sealed class SwimLane : BaseShape

[DomainModelOwnerAttribute(typeof(DslDefinitionModelDomainModel))]
[DomainObjectIdAttribute(L"eef3cdf6-7211-4458-afc4-24baf956524e")]
[CLSCompliantAttribute(true)]
[DisplayNameResourceAttribute(L"Microsoft.VisualStudio.Modeling.DslDefinition.SwimLane.DisplayName", 
    typeof(DslDefinitionModelDomainModel), L"Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")]
[DescriptionResourceAttribute(L"Microsoft.VisualStudio.Modeling.DslDefinition.SwimLane.Description", 
    typeof(DslDefinitionModelDomainModel), L"Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")]
public ref class SwimLane sealed : public BaseShape

[<Sealed>]
[<DomainModelOwnerAttribute(typeof(DslDefinitionModelDomainModel))>]
[<DomainObjectIdAttribute("eef3cdf6-7211-4458-afc4-24baf956524e")>]
[<CLSCompliantAttribute(true)>]
[<DisplayNameResourceAttribute("Microsoft.VisualStudio.Modeling.DslDefinition.SwimLane.DisplayName", 
    typeof(DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")>]
[<DescriptionResourceAttribute("Microsoft.VisualStudio.Modeling.DslDefinition.SwimLane.Description", 
    typeof(DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")>]
type SwimLane =  
    class
        inherit BaseShape
    end

public final class SwimLane extends BaseShape

The SwimLane type exposes the following members.

Constructors

	Name	Description
	SwimLane(Partition, array<PropertyAssignment[])	Constructor
	SwimLane(Store, array<PropertyAssignment[])	Constructor

Top

Properties

	Name	Description
	AccessModifier	Gets or sets the value of AccessModifier ___domain property. Determines if the access modifier for the ___domain class is public or internal. (Inherited from DomainClass.)
	Alignment	Gets or sets the value of Alignment ___domain property. Whether the swimlane is horizontally or vertically aligned.
	AllDescendants	Gets a read-only list of all ___domain classes directly or indirectly derived from this one. (Inherited from DomainClass.)
	AllProperties	The set of all DomainProperties both defined on this class and inherited from base classes. (Inherited from DomainClass.)
	AllRolesPlayed	The set of all DomainRoles both played directly by this class and inherited from base classes. (Inherited from DomainClass.)
	Attributes	Gets a list of Attributes. (Inherited from AttributedDomainElement.)
	BaseClass	Gets or sets BaseClass. Base swimlane of this swimlane. (Overrides DomainClass.BaseClass.)
	BodyFillColor	Gets or sets the value of BodyFillColor ___domain property. Fill color for the body of the swimlane.
	ClassData	Gets or sets ClassData. Xml serialization configuration data for the ___domain class. (Inherited from DomainClass.)
	CustomAttributes	Gets or sets the value of CustomAttributes ___domain property. Used to attribute the code generated from this element. (Inherited from AttributedDomainElement.)
	CustomTypeDescriptor	Gets or sets CustomTypeDescriptor. Definition of the custom type descriptor for the class. (Inherited from DomainClass.)
	Decorators	Gets a list of Decorators. Decorators defined by the swimlane.
	Description	Gets or sets the value of Description ___domain property. Used in the UI and in the code documentation of the generated designer. (Inherited from AttributedDomainElement.)
	DisplayName	Gets or sets the value of DisplayName ___domain property. The name that will be displayed in the generated designer for this element. (Inherited from NamedDomainElement.)
	DslLibrary	Gets or sets DslLibrary. Dsl library defining the shape. (Inherited from BaseShape.)
	ElementMergeDirectives	Gets a list of ElementMergeDirectives. (Inherited from DomainClass.)
	ExposesTextColor	Gets or sets the value of ExposesTextColor ___domain property. If True, a ___domain property has been added to the connector to allow the text color to be exposed in the properties window of the generated designer. (Inherited from DiagramElement.)
	FixedTooltipText	Gets or sets the value of FixedTooltipText ___domain property. Text used for a fixed tooltip. (Inherited from DiagramElement.)
	GeneratesDoubleDerived	Gets or sets the value of GeneratesDoubleDerived ___domain property. If True, will generate both a base class with all functionality and a partial class to support customization through overrides. (Inherited from DomainClass.)
	HasCustomConstructor	Gets or sets the value of HasCustomConstructor ___domain property. If True, indicates that a custom constructor will be provided in the generated code. (Inherited from DomainClass.)
	HeaderFillColor	Gets or sets the value of HeaderFillColor ___domain property. Fill color for the header of the swimlane.
	HelpKeyword	Gets or sets the value of HelpKeyword ___domain property. Optional keyword used to index F1 help for this element. (Inherited from NamedDomainElement.)
	Id	Gets the ID of the element. (Inherited from ModelElement.)
	InheritanceModifier	Gets or sets the value of InheritanceModifier ___domain property. Determines if the inheritance modifier of the .NET class generated from the ___domain class is none, abstract or sealed. (Inherited from DomainClass.)
	InitialHeight	Gets or sets the value of InitialHeight ___domain property. Initial height of this swimlane, in inches. Only applicable to horizontal swimlanes.
	InitialWidth	Gets or sets the value of InitialWidth ___domain property. Initial width of this swimlane, in inches. Only applicable to vertical swimlanes.
	IsActive	Gets the IsActive flag and verifies to see whether the element is active. (Inherited from ModelElement.)
	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.)
	IsDescriptionTracking	Gets or sets the value of IsDescriptionTracking ___domain property. If True, the Description property tracks other data in the DSL definition. (Inherited from AttributedDomainElement.)
	IsDisplayNameTracking	Gets or sets the value of IsDisplayNameTracking ___domain property. If True, the DisplayName property tracks other data in the DSL definition. (Inherited from NamedDomainElement.)
	IsFixedTooltipTextTracking	Gets or sets the value of IsFixedTooltipTextTracking ___domain property. If True, the FixedTooltipText property tracks other data in the DSL definition. (Inherited from DiagramElement.)
	IsNamespaceTracking	Gets or sets the value of IsNamespaceTracking ___domain property. If True, the Namespace property tracks other data in the DSL definition. (Inherited from DomainClass.)
	Name	Gets or sets the value of Name ___domain property. Name of this element. (Inherited from NamedDomainElement.)
	Namespace	Gets or sets the value of Namespace ___domain property. Namespace affiliated with this ___domain class. (Inherited from DomainClass.)
	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.)
	Properties	Gets a list of Properties. (Inherited from DomainClass.)
	ProxyIsNameTracking	(Inherited from NamedDomainElement.)
	RolesPlayed	Gets a list of RolesPlayed. Roles played by the class. (Inherited from DomainClass.)
	SeparatorColor	Gets or sets the value of SeparatorColor ___domain property. Color of the separator line.
	SeparatorLineStyle	Gets or sets the value of SeparatorLineStyle ___domain property. Style of the separator line.
	SeparatorThickness	Gets or sets the value of SeparatorThickness ___domain property. Thickness of the separator line.
	Store	Gets the Store that contains the element. (Inherited from ModelElement.)
	SubClasses	Gets a list of SubClasses. (Overrides DomainClass.SubClasses.)
	TextColor	Gets or sets the value of TextColor ___domain property. Color used for text decorators associated with this diagram element. (Inherited from DiagramElement.)
	TooltipType	Gets or sets the value of TooltipType ___domain property. If Fixed, the fixed tooltip text is used as the tooltip, if variable the tooltip is defined in custom code. (Inherited from DiagramElement.)

Top

Methods

	Name	Description
	CalculateDescription	Calculate the value of Description (Inherited from DomainClass.)
	CalculateName	Calculates the value of Name (Inherited from NamedDomainElement.)
	CanMerge	Returns a value indicating whether the source element represented by the specified root ProtoElement can be added to this element. (Inherited from DomainClass.)
	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.)
	GetFullName	Gets the fully qualified name for this class (Inherited from DomainClass.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetRelativeName	Gets the name of the ___domain class relative to the current namespace. If the current namespace is the same as this.Namespace, then we return this.Name. If not, we return this.GetFullName() (Inherited from DomainClass.)
	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.)
	IsDerivedFrom	Test if this class is derived from the given class. (Inherited from DomainClass.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	MergeConfigure	Configure a newly merged DomainClass (Inherited from DomainClass.)
	MergeDisconnect	Performs operation opposite to MergeRelate - i.e. disconnects a given element from the current one (removes links created by MergeRelate). (Inherited from DomainClass.)
	MergeRelate	Called by the Merge process to create a relationship between this target element and the specified source element. Typically, a parent-child relationship is established between the target element (the parent) and the source element (the child), but any relationship can be established. (Inherited from DomainClass.)
	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.)
	OnInheritanceModifierChanged	Called when InheritanceModifier on a DomainClass changes (Inherited from DomainClass.)
	OnNameChanged	Name of DiagramElement changed (Inherited from DiagramElement.)
	OnNamespaceChanged	Called when the Namespace of a DomainClass changes (Inherited from DomainClass.)
	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
	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
	AlignmentDomainPropertyId	Alignment ___domain property Id.
	BodyFillColorDomainPropertyId	BodyFillColor ___domain property Id.
	DomainClassId	SwimLane ___domain class Id.
	HeaderFillColorDomainPropertyId	HeaderFillColor ___domain property Id.
	InitialHeightDomainPropertyId	InitialHeight ___domain property Id.
	InitialWidthDomainPropertyId	InitialWidth ___domain property Id.
	SeparatorColorDomainPropertyId	SeparatorColor ___domain property Id.
	SeparatorLineStyleDomainPropertyId	SeparatorLineStyle ___domain property Id.
	SeparatorThicknessDomainPropertyId	SeparatorThickness ___domain property Id.

Top

Explicit Interface Implementations

	Name	Description
	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.

See Also

Reference

Microsoft.VisualStudio.Modeling.DslDefinition Namespace