ElementListCompartmentMapping Class

Article
02/04/2013

A mapping for ListCompartments that knows about the relationship that's being modeled in the compartment, and the property that's being displayed in the list.

Inheritance Hierarchy

System.Object
Microsoft.VisualStudio.Modeling.Diagrams.CompartmentMapping
Microsoft.VisualStudio.Modeling.Diagrams.ElementListCompartmentMapping

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

Syntax

'Declaration
Public Class ElementListCompartmentMapping _
    Inherits CompartmentMapping

public class ElementListCompartmentMapping : CompartmentMapping

public ref class ElementListCompartmentMapping : public CompartmentMapping

type ElementListCompartmentMapping =  
    class
        inherit CompartmentMapping
    end

public class ElementListCompartmentMapping extends CompartmentMapping

The ElementListCompartmentMapping type exposes the following members.

Constructors

	Name	Description
	ElementListCompartmentMapping(String, Guid, ElementListGetter, DisplayStringGetter, DisplayImageGetter)	Constructor for a mapping that does not use a domain property but uses a fully custom string for display name.
	ElementListCompartmentMapping(String, Guid, Guid, ElementListGetter, PropertyElementGetter, DisplayStringGetter, DisplayImageGetter)	Constructor that takes all of the initial values.

Top

Properties

	Name	Description
	CompartmentId	Gets or sets the Compartment identifier. (Inherited from CompartmentMapping.)
	DefaultDomainClassId	Gets or sets the DomainClassId of the default type of item that will get created and added to the appropriate list.
	ElementListGetter	Get/Set the element list delegate
	ImageGetter	Get/Set the line item image delegate
	PropertyElementGetter	Get/Set the property element delegate
	PropertyId	Gets or sets the PropertyId for the ElementListCompartment's display item.
	StringGetter	Get/Set the line item text delegate

Top

Methods

	Name	Description
	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.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	InitializeCompartment	Initialize the compartment from its mapping data. (Overrides CompartmentMapping.InitializeCompartment(Compartment).)
	InitializeCompartmentShape	Update the compartment specified by this mapping with the value specified by this mapping from the object model (Inherited from CompartmentMapping.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

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.