ICommentedDocument interface

No description yet.

public interface ICommentedDocument

Namespace: DXP · Assembly: Altium.SDK.Interfaces

Properties

Property	Type	Access	Description
ActiveCommentThread	IEDMS_CommentThreadHolder	get; set

ActiveCommentThread

No description yet.

IEDMS_CommentThreadHolder GetActiveCommentThread();
void SetActiveCommentThread(IEDMS_CommentThreadHolder argCommentThread);

Type: IEDMS_CommentThreadHolder · Access: read/write

The accessors are extension methods of ICommentedDocumentHelper (using DXP;).

Methods

Method	Returns	Description
AddCommentThread	void
ClearCommentThreads	void
GetCommentThread	IEDMS_CommentThreadHolder
GetCommentThreadByGUID	IEDMS_CommentThreadHolder
GetCommentThreadsCount	int
SelectCommentThread	bool

AddCommentThread

No description yet.

void AddCommentThread(IEDMS_CommentThreadHolder argCommentThread);
void AddCommentThread(object argCommentThread);

Parameter	Type	Passing
argCommentThread	IEDMS_CommentThreadHolder	value

Returns: nothing (void)

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

ClearCommentThreads

No description yet.

void ClearCommentThreads();

Returns: nothing (void)

GetCommentThread

No description yet.

IEDMS_CommentThreadHolder GetCommentThread(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: IEDMS_CommentThreadHolder

Extension method of ICommentedDocumentHelper (using DXP;).

GetCommentThreadByGUID

No description yet.

IEDMS_CommentThreadHolder GetCommentThreadByGUID(string argThreadGUID);

Parameter	Type	Passing
argThreadGUID	string	value

Returns: IEDMS_CommentThreadHolder

Extension method of ICommentedDocumentHelper (using DXP;).

GetCommentThreadsCount

No description yet.

int GetCommentThreadsCount();

Returns: int

SelectCommentThread

No description yet.

bool SelectCommentThread(IEDMS_CommentThreadHolder argCommentThread);
bool SelectCommentThread(object argCommentThread);

Parameter	Type	Passing
argCommentThread	IEDMS_CommentThreadHolder	value

Returns: bool

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