# ICommentService interface

*No description yet.*

```csharp
public interface ICommentService
```

**Namespace:** EDP · **Assembly:** Altium.SDK.Interfaces

## Methods

| Method | Returns | Description |
| --- | --- | --- |
| [AddCommentThread](#addcommentthread) | `void` |  |
| [CloseActiveCommentThreadPopup](#closeactivecommentthreadpopup) | `void` |  |
| [CommentingAvailable](#commentingavailable) | `bool` |  |
| [CommentsFeatureAvailable](#commentsfeatureavailable) | `bool` |  |
| [CreateCommentThreadGraphical](#createcommentthreadgraphical) | [ICommentThreadGraphical](https://altiumdeveloper.github.io/ad-sdk-docs/reference/edp/ICommentThreadGraphical.md) |  |
| [CreateRequirementsTask](#createrequirementstask) | `void` |  |
| [GetCanPlaceComment](#getcanplacecomment) | `bool` |  |
| [GetCommentThread](#getcommentthread) | [ICommentThread](https://altiumdeveloper.github.io/ad-sdk-docs/reference/edp/ICommentThread.md) |  |
| [GetCommentThreadsCount](#getcommentthreadscount) | `int` |  |
| [GetDocumentCommentThreads](#getdocumentcommentthreads) | [ICommentThreadList](https://altiumdeveloper.github.io/ad-sdk-docs/reference/edp/ICommentThreadList.md) |  |
| [GetDocumentCommentThreadsEx](#getdocumentcommentthreadsex) | [ICommentThreadList](https://altiumdeveloper.github.io/ad-sdk-docs/reference/edp/ICommentThreadList.md) |  |
| [GetDrawingItemCarrier](#getdrawingitemcarrier) | [ICommentDrawingItemCarrier](https://altiumdeveloper.github.io/ad-sdk-docs/reference/edp/ICommentDrawingItemCarrier.md) |  |
| [GetPlacedRequirementThreads](#getplacedrequirementthreads) | [ICommentThreadList](https://altiumdeveloper.github.io/ad-sdk-docs/reference/edp/ICommentThreadList.md) |  |
| [GetShowCommentsOnDocument](#getshowcommentsondocument) | `bool` |  |
| [OnBeginDrawingItemPlaceProcess](#onbegindrawingitemplaceprocess) | `void` |  |
| [OnEndDrawingItemPlaceProcess](#onenddrawingitemplaceprocess) | `void` |  |
| [PreviewPlaceComment](#previewplacecomment) | `bool` |  |
| [SearchUsers](#searchusers) | [IUserProfileList](https://altiumdeveloper.github.io/ad-sdk-docs/reference/edp/IUserProfileList.md) |  |
| [SetActivePopupPosition](#setactivepopupposition) | `void` |  |
| [ShowCommentsOnDocumentTemporary](#showcommentsondocumenttemporary) | `void` |  |
| [ShowCommentThread](#showcommentthread) | `void` |  |
| [ShowCommentThreadPopup](#showcommentthreadpopup) | `void` |  |
| [ShowCommentThreadPopupEx](#showcommentthreadpopupex) | `void` |  |
| [StartPlaceComment](#startplacecomment) | `void` |  |
| [UpdateCommentThread](#updatecommentthread) | `void` |  |

### AddCommentThread

*No description yet.*

```csharp
void AddCommentThread(ICommentThread argCommentThread, uint argBitmap);
void AddCommentThread(object argCommentThread, uint argBitmap);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argCommentThread` | [ICommentThread](https://altiumdeveloper.github.io/ad-sdk-docs/reference/edp/ICommentThread.md) | value |
| `argBitmap` | `uint` | value |

**Returns:** nothing (`void`)

The first overload is an extension method of `ICommentServiceHelper` (`using EDP;`) with typed parameters; the second is declared by the interface.

### CloseActiveCommentThreadPopup

*No description yet.*

```csharp
void CloseActiveCommentThreadPopup();
```

**Returns:** nothing (`void`)

### CommentingAvailable

*No description yet.*

```csharp
bool CommentingAvailable(IDXPProject argProject, string argDocumentUniqueId, string argDocumentName, out string argMessage);
bool CommentingAvailable(object argProject, string argDocumentUniqueId, string argDocumentName, out string argMessage);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argProject` | [IDXPProject](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IDXPProject.md) | value |
| `argDocumentUniqueId` | `string` | value |
| `argDocumentName` | `string` | value |
| `argMessage` | `string` | out |

**Returns:** `bool`

The first overload is an extension method of `ICommentServiceHelper` (`using EDP;`) with typed parameters; the second is declared by the interface.

### CommentsFeatureAvailable

*No description yet.*

```csharp
bool CommentsFeatureAvailable(string argDocumentKind, out string argFeatureState);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argDocumentKind` | `string` | value |
| `argFeatureState` | `string` | out |

**Returns:** `bool`

### CreateCommentThreadGraphical

*No description yet.*

```csharp
ICommentThreadGraphical CreateCommentThreadGraphical();
```

**Returns:** [ICommentThreadGraphical](https://altiumdeveloper.github.io/ad-sdk-docs/reference/edp/ICommentThreadGraphical.md)

Extension method of `ICommentServiceHelper` (`using EDP;`).

### CreateRequirementsTask

*No description yet.*

```csharp
void CreateRequirementsTask(string argAssigneeId, string argCommentText);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argAssigneeId` | `string` | value |
| `argCommentText` | `string` | value |

**Returns:** nothing (`void`)

### GetCanPlaceComment

*No description yet.*

```csharp
bool GetCanPlaceComment(string argParameters);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argParameters` | `string` | value |

**Returns:** `bool`

### GetCommentThread

*No description yet.*

```csharp
ICommentThread GetCommentThread(string argManagedProjectGUID, string argThreadId);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argManagedProjectGUID` | `string` | value |
| `argThreadId` | `string` | value |

**Returns:** [ICommentThread](https://altiumdeveloper.github.io/ad-sdk-docs/reference/edp/ICommentThread.md)

Extension method of `ICommentServiceHelper` (`using EDP;`).

### GetCommentThreadsCount

*No description yet.*

```csharp
int GetCommentThreadsCount(string argManagedProjectGUID, bool argIncludeNew);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argManagedProjectGUID` | `string` | value |
| `argIncludeNew` | `bool` | value |

**Returns:** `int`

### GetDocumentCommentThreads

*No description yet.*

```csharp
ICommentThreadList GetDocumentCommentThreads(string argManagedProjectGUID, string argDocumentUniqueId);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argManagedProjectGUID` | `string` | value |
| `argDocumentUniqueId` | `string` | value |

**Returns:** [ICommentThreadList](https://altiumdeveloper.github.io/ad-sdk-docs/reference/edp/ICommentThreadList.md)

Extension method of `ICommentServiceHelper` (`using EDP;`).

### GetDocumentCommentThreadsEx

*No description yet.*

```csharp
ICommentThreadList GetDocumentCommentThreadsEx(string argManagedProjectGUID, string argDocumentUniqueId, string argDocumentName);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argManagedProjectGUID` | `string` | value |
| `argDocumentUniqueId` | `string` | value |
| `argDocumentName` | `string` | value |

**Returns:** [ICommentThreadList](https://altiumdeveloper.github.io/ad-sdk-docs/reference/edp/ICommentThreadList.md)

Extension method of `ICommentServiceHelper` (`using EDP;`).

### GetDrawingItemCarrier

*No description yet.*

```csharp
ICommentDrawingItemCarrier GetDrawingItemCarrier(string argDocumentKind, TDrawingItemType argItemType);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argDocumentKind` | `string` | value |
| `argItemType` | [TDrawingItemType](https://altiumdeveloper.github.io/ad-sdk-docs/reference/edp/TDrawingItemType.md) | value |

**Returns:** [ICommentDrawingItemCarrier](https://altiumdeveloper.github.io/ad-sdk-docs/reference/edp/ICommentDrawingItemCarrier.md)

Extension method of `ICommentServiceHelper` (`using EDP;`).

### GetPlacedRequirementThreads

*No description yet.*

```csharp
ICommentThreadList GetPlacedRequirementThreads(string argManagedProjectGUID, string argRequirementItemId);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argManagedProjectGUID` | `string` | value |
| `argRequirementItemId` | `string` | value |

**Returns:** [ICommentThreadList](https://altiumdeveloper.github.io/ad-sdk-docs/reference/edp/ICommentThreadList.md)

Extension method of `ICommentServiceHelper` (`using EDP;`).

### GetShowCommentsOnDocument

*No description yet.*

```csharp
bool GetShowCommentsOnDocument(string argManagedProjectGUID);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argManagedProjectGUID` | `string` | value |

**Returns:** `bool`

### OnBeginDrawingItemPlaceProcess

*No description yet.*

```csharp
void OnBeginDrawingItemPlaceProcess(string argCommentThreadId);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argCommentThreadId` | `string` | value |

**Returns:** nothing (`void`)

### OnEndDrawingItemPlaceProcess

*No description yet.*

```csharp
void OnEndDrawingItemPlaceProcess(string argCommentThreadId);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argCommentThreadId` | `string` | value |

**Returns:** nothing (`void`)

### PreviewPlaceComment

*No description yet.*

```csharp
bool PreviewPlaceComment();
```

**Returns:** `bool`

### SearchUsers

*No description yet.*

```csharp
IUserProfileList SearchUsers(string argSearchQuery);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argSearchQuery` | `string` | value |

**Returns:** [IUserProfileList](https://altiumdeveloper.github.io/ad-sdk-docs/reference/edp/IUserProfileList.md)

Extension method of `ICommentServiceHelper` (`using EDP;`).

### SetActivePopupPosition

*No description yet.*

```csharp
void SetActivePopupPosition(int argX, int argY);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argX` | `int` | value |
| `argY` | `int` | value |

**Returns:** nothing (`void`)

### ShowCommentsOnDocumentTemporary

*No description yet.*

```csharp
void ShowCommentsOnDocumentTemporary(string argManagedProjectGUID, string argDocumentUniqueId, string argDocumentName);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argManagedProjectGUID` | `string` | value |
| `argDocumentUniqueId` | `string` | value |
| `argDocumentName` | `string` | value |

**Returns:** nothing (`void`)

### ShowCommentThread

*No description yet.*

```csharp
void ShowCommentThread(string argManagedProjectGUID, string argThreadId);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argManagedProjectGUID` | `string` | value |
| `argThreadId` | `string` | value |

**Returns:** nothing (`void`)

### ShowCommentThreadPopup

*No description yet.*

```csharp
void ShowCommentThreadPopup(string argManagedProjectGUID, string argThreadId, int argX, int argY);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argManagedProjectGUID` | `string` | value |
| `argThreadId` | `string` | value |
| `argX` | `int` | value |
| `argY` | `int` | value |

**Returns:** nothing (`void`)

### ShowCommentThreadPopupEx

*No description yet.*

```csharp
void ShowCommentThreadPopupEx(string argManagedProjectGUID, string argThreadId, int argX, int argY, TPopupHorizontalAlignment argHorizontalAlignment, string argHeaderText, string argHeaderTooltip);
void ShowCommentThreadPopupEx(string argManagedProjectGUID, string argThreadId, int argX, int argY, int argHorizontalAlignment, string argHeaderText, string argHeaderTooltip);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argManagedProjectGUID` | `string` | value |
| `argThreadId` | `string` | value |
| `argX` | `int` | value |
| `argY` | `int` | value |
| `argHorizontalAlignment` | [TPopupHorizontalAlignment](https://altiumdeveloper.github.io/ad-sdk-docs/reference/edp/TPopupHorizontalAlignment.md) | value |
| `argHeaderText` | `string` | value |
| `argHeaderTooltip` | `string` | value |

**Returns:** nothing (`void`)

The first overload is an extension method of `ICommentServiceHelper` (`using EDP;`) with typed parameters; the second is declared by the interface.

### StartPlaceComment

*No description yet.*

```csharp
void StartPlaceComment(string argParameters);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argParameters` | `string` | value |

**Returns:** nothing (`void`)

### UpdateCommentThread

*No description yet.*

```csharp
void UpdateCommentThread(ICommentThread argCommentThread);
void UpdateCommentThread(object argCommentThread);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argCommentThread` | [ICommentThread](https://altiumdeveloper.github.io/ad-sdk-docs/reference/edp/ICommentThread.md) | value |

**Returns:** nothing (`void`)

The first overload is an extension method of `ICommentServiceHelper` (`using EDP;`) with typed parameters; the second is declared by the interface.

## Returned by

[ICommentServerModule.GetCommentService](https://altiumdeveloper.github.io/ad-sdk-docs/reference/edp/ICommentServerModule.md#getcommentservice)