ILayerComment Interface
[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]
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)
Syntax
'Declaration
Public Interface ILayerComment _
Inherits ILayerElement
public interface ILayerComment : ILayerElement
public interface class ILayerComment : ILayerElement
type ILayerComment =
interface
interface ILayerElement
end
public interface ILayerComment extends ILayerElement
The ILayerComment type exposes the following members.
Properties
Name | Description | |
---|---|---|
Body | Get/set the comment text. | |
Description | (Inherited from ILayerElement.) | |
Id | (Inherited from ILayerElement.) | |
IsDeleted | (Inherited from ILayerElement.) | |
Links | Gets the elements linked to this comment. | |
Name | (Inherited from ILayerElement.) | |
Parent | Get the parent container, either an ILayer or an ILayerModel. | |
Properties | (Inherited from ILayerElement.) |
Top
Extension Methods
Name | Description | |
---|---|---|
CreateCommentLink(ILayer) | Overloaded. Link this comment to a layer. (Defined by Extensions.) | |
CreateCommentLink(ILayerComment) | Overloaded. Link this layer to a comment. (Defined by Extensions.) | |
Delete | Delete the element. (Defined by Extensions.) | |
GetShape | Get the shape that presents this layer element. (Defined by Extensions.) |
Top
Remarks
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.
See Also
Reference
Microsoft.VisualStudio.ArchitectureTools.Extensibility.Layer Namespace