Interface ICommentProperties
Thread of comments
Inherited Members
Namespace: SdlSdl.FileTypeSupportFrameworkNativeApi
Assembly: Sdl.FileTypeSupport.Framework.Core.dll
Syntax
public interface ICommentProperties : ICloneableRemarks
This interface was designed to correspond to the commenting features available in TTX and ITD files.
Properties
Comments
Iterator for accessing comments sequentially
Declaration
IEnumerable<IComment> Comments { get; }Property Value
| Type | Description |
|---|---|
| IEnumerableIComment |
Count
The number of comments in this thread
Declaration
int Count { get; }Property Value
| Type | Description |
|---|---|
| int |
Xml
An XML string that is meant for serializing the comment thread.
Declaration
string Xml { get; set; }Property Value
| Type | Description |
|---|---|
| string |
Remarks
The XML format of this string is the same as the comments XML format used in ITD and TTX files.
Setting this property changes the entire content of the comment properties object.
Methods
Add(IComment)
Appends a comment to this thread
Declaration
void Add(IComment comment)Parameters
| Type | Name | Description |
|---|---|---|
| IComment | comment |
AddComments(ICommentProperties)
Appends all comments from another thread to this one
Declaration
void AddComments(ICommentProperties comments)Parameters
| Type | Name | Description |
|---|---|---|
| ICommentProperties | comments |
Delete(IComment)
Removes a comment from the collection.
Declaration
void Delete(IComment comment)Parameters
| Type | Name | Description |
|---|---|---|
| IComment | comment |
GetItem(int)
Gets the comment with the specified index. The index is 0-based.
Declaration
IComment GetItem(int index)Parameters
| Type | Name | Description |
|---|---|---|
| int | index |
Returns
| Type | Description |
|---|---|
| IComment |