ICommentService interface

No description yet.

public interface ICommentService

Namespace: EDP · Assembly: Altium.SDK.Interfaces

Methods

Method	Returns	Description
AddCommentThread	void
CloseActiveCommentThreadPopup	void
CommentingAvailable	bool
CommentsFeatureAvailable	bool
CreateCommentThreadGraphical	ICommentThreadGraphical
CreateRequirementsTask	void
GetCanPlaceComment	bool
GetCommentThread	ICommentThread
GetCommentThreadsCount	int
GetDocumentCommentThreads	ICommentThreadList
GetDocumentCommentThreadsEx	ICommentThreadList
GetDrawingItemCarrier	ICommentDrawingItemCarrier
GetPlacedRequirementThreads	ICommentThreadList
GetShowCommentsOnDocument	bool
OnBeginDrawingItemPlaceProcess	void
OnEndDrawingItemPlaceProcess	void
PreviewPlaceComment	bool
SearchUsers	IUserProfileList
SetActivePopupPosition	void
ShowCommentsOnDocumentTemporary	void
ShowCommentThread	void
ShowCommentThreadPopup	void
ShowCommentThreadPopupEx	void
StartPlaceComment	void
UpdateCommentThread	void

AddCommentThread

No description yet.

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

Parameter	Type	Passing
argCommentThread	ICommentThread	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.

void CloseActiveCommentThreadPopup();

Returns: nothing (void)

CommentingAvailable

No description yet.

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	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.

bool CommentsFeatureAvailable(string argDocumentKind, out string argFeatureState);

Parameter	Type	Passing
argDocumentKind	string	value
argFeatureState	string	out

Returns: bool

CreateCommentThreadGraphical

No description yet.

ICommentThreadGraphical CreateCommentThreadGraphical();

Returns: ICommentThreadGraphical

Extension method of ICommentServiceHelper (using EDP;).

CreateRequirementsTask

No description yet.

void CreateRequirementsTask(string argAssigneeId, string argCommentText);

Parameter	Type	Passing
argAssigneeId	string	value
argCommentText	string	value

Returns: nothing (void)

GetCanPlaceComment

No description yet.

bool GetCanPlaceComment(string argParameters);

Parameter	Type	Passing
argParameters	string	value

Returns: bool

GetCommentThread

No description yet.

ICommentThread GetCommentThread(string argManagedProjectGUID, string argThreadId);

Parameter	Type	Passing
argManagedProjectGUID	string	value
argThreadId	string	value

Returns: ICommentThread

Extension method of ICommentServiceHelper (using EDP;).

GetCommentThreadsCount

No description yet.

int GetCommentThreadsCount(string argManagedProjectGUID, bool argIncludeNew);

Parameter	Type	Passing
argManagedProjectGUID	string	value
argIncludeNew	bool	value

Returns: int

GetDocumentCommentThreads

No description yet.

ICommentThreadList GetDocumentCommentThreads(string argManagedProjectGUID, string argDocumentUniqueId);

Parameter	Type	Passing
argManagedProjectGUID	string	value
argDocumentUniqueId	string	value

Returns: ICommentThreadList

Extension method of ICommentServiceHelper (using EDP;).

GetDocumentCommentThreadsEx

No description yet.

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

Parameter	Type	Passing
argManagedProjectGUID	string	value
argDocumentUniqueId	string	value
argDocumentName	string	value

Returns: ICommentThreadList

Extension method of ICommentServiceHelper (using EDP;).

GetDrawingItemCarrier

No description yet.

ICommentDrawingItemCarrier GetDrawingItemCarrier(string argDocumentKind, TDrawingItemType argItemType);

Parameter	Type	Passing
argDocumentKind	string	value
argItemType	TDrawingItemType	value

Returns: ICommentDrawingItemCarrier

Extension method of ICommentServiceHelper (using EDP;).

GetPlacedRequirementThreads

No description yet.

ICommentThreadList GetPlacedRequirementThreads(string argManagedProjectGUID, string argRequirementItemId);

Parameter	Type	Passing
argManagedProjectGUID	string	value
argRequirementItemId	string	value

Returns: ICommentThreadList

Extension method of ICommentServiceHelper (using EDP;).

GetShowCommentsOnDocument

No description yet.

bool GetShowCommentsOnDocument(string argManagedProjectGUID);

Parameter	Type	Passing
argManagedProjectGUID	string	value

Returns: bool

OnBeginDrawingItemPlaceProcess

No description yet.

void OnBeginDrawingItemPlaceProcess(string argCommentThreadId);

Parameter	Type	Passing
argCommentThreadId	string	value

Returns: nothing (void)

OnEndDrawingItemPlaceProcess

No description yet.

void OnEndDrawingItemPlaceProcess(string argCommentThreadId);

Parameter	Type	Passing
argCommentThreadId	string	value

Returns: nothing (void)

PreviewPlaceComment

No description yet.

bool PreviewPlaceComment();

Returns: bool

SearchUsers

No description yet.

IUserProfileList SearchUsers(string argSearchQuery);

Parameter	Type	Passing
argSearchQuery	string	value

Returns: IUserProfileList

Extension method of ICommentServiceHelper (using EDP;).

SetActivePopupPosition

No description yet.

void SetActivePopupPosition(int argX, int argY);

Parameter	Type	Passing
argX	int	value
argY	int	value

Returns: nothing (void)

ShowCommentsOnDocumentTemporary

No description yet.

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.

void ShowCommentThread(string argManagedProjectGUID, string argThreadId);

Parameter	Type	Passing
argManagedProjectGUID	string	value
argThreadId	string	value

Returns: nothing (void)

ShowCommentThreadPopup

No description yet.

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.

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	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.

void StartPlaceComment(string argParameters);

Parameter	Type	Passing
argParameters	string	value

Returns: nothing (void)

UpdateCommentThread

No description yet.

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

Parameter	Type	Passing
argCommentThread	ICommentThread	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