ILayerComment Interface

 

Comment element. A comment can be contained in a layer model or in a layer, and can also be linked to any number of layers.

Namespace:   Microsoft.VisualStudio.ArchitectureTools.Extensibility.Layer
Assembly:  Microsoft.VisualStudio.ArchitectureTools.Extensibility.Layer (in Microsoft.VisualStudio.ArchitectureTools.Extensibility.Layer.dll)

public interface ILayerComment : ILayerElement

NameDescription
System_CAPS_pubpropertyBody

Get/set the comment text.

System_CAPS_pubpropertyDescription

Get/set the description.(Inherited from ILayerElement.)

System_CAPS_pubpropertyId

Gets the unique identifier of this element.(Inherited from ILayerElement.)

System_CAPS_pubpropertyIsDeleted

Check whether this element has been deleted.(Inherited from ILayerElement.)

System_CAPS_pubpropertyLinks

Gets the elements linked to this comment.

System_CAPS_pubpropertyName

Get/set the unique name.(Inherited from ILayerElement.)

System_CAPS_pubpropertyParent

Get the parent container, either an ILayer or an ILayerModel.

System_CAPS_pubpropertyProperties

Gets a string dictionary that you can use to store arbitrary data with each ILayerElement.(Inherited from ILayerElement.)

NameDescription
System_CAPS_pubmethodCreateCommentLink(ILayer)

Overloaded. Link this comment to a layer.(Defined by Extensions.)

System_CAPS_pubmethodCreateCommentLink(ILayerComment)

Overloaded. Link this layer to a comment.(Defined by Extensions.)

System_CAPS_pubmethodDelete()

Overloaded. Delete the element.(Defined by Extensions.)

System_CAPS_pubmethodGetShape()

Get the shape that presents this layer element.(Defined by Extensions.)

To obtain the comments attached to a layer element, use:

ILayerModel model = diagram.GetLayerModel(); 
IEnumerable<ILayerComment> comments = model.Comments
  .Where(comment => comment.Links
     .Any(link => link.Target == layerElement));

Notice that the Comments property of an ILayerElement gets comments that are contained within the ILayerElement - not comments that are linked to it.

Return to top
Show: