IDXPMessagesManager interface

No description yet.

public interface IDXPMessagesManager

Namespace: DXP · Assembly: Altium.SDK.Interfaces

Methods

Method	Returns	Description
AddMessage	void
AddMessage2	void
AddMessageParametric	void
BeginPreserve	void
BeginUpdate	void
ClearMessageByIndex	void
ClearMessages	void
ClearMessagesForDocument	void
ClearMessagesOfClass	void
CreateMesssageItemDetails	IDXPMessageItemDetails
EndPreserve	void
EndUpdate	void
GetMaxErrorLevel	TErrorLevel
Messages	IDXPMessageItem
MessagesCount	int

AddMessage

No description yet.

void AddMessage(string argMessageClass, string argMessageText, string argMessageSource, string argMessageDocument, string argMessageCallBackProcess, string argMessageCallBackParameters, int argImageIndex, bool argReplaceLastMessageIfSameClass, string argMessageCallBackProcess2, string argMessageCallBackParameters2);

Parameter	Type	Passing
argMessageClass	string	value
argMessageText	string	value
argMessageSource	string	value
argMessageDocument	string	value
argMessageCallBackProcess	string	value
argMessageCallBackParameters	string	value
argImageIndex	int	value
argReplaceLastMessageIfSameClass	bool	value
argMessageCallBackProcess2	string	value
argMessageCallBackParameters2	string	value

Returns: nothing (void)

AddMessage2

No description yet.

void AddMessage2(string argMessageClass, string argMessageText, string argMessageSource, string argMessageDocument, string argMessageCallBackProcess, string argMessageCallBackParameters, int argImageIndex, bool argReplaceLastMessageIfSameClass, string argMessageCallBackProcess2, string argMessageCallBackParameters2, IDXPMessageItemDetails argDetails);
void AddMessage2(string argMessageClass, string argMessageText, string argMessageSource, string argMessageDocument, string argMessageCallBackProcess, string argMessageCallBackParameters, int argImageIndex, bool argReplaceLastMessageIfSameClass, string argMessageCallBackProcess2, string argMessageCallBackParameters2, object argDetails);

Parameter	Type	Passing
argMessageClass	string	value
argMessageText	string	value
argMessageSource	string	value
argMessageDocument	string	value
argMessageCallBackProcess	string	value
argMessageCallBackParameters	string	value
argImageIndex	int	value
argReplaceLastMessageIfSameClass	bool	value
argMessageCallBackProcess2	string	value
argMessageCallBackParameters2	string	value
argDetails	IDXPMessageItemDetails	value

Returns: nothing (void)

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

AddMessageParametric

No description yet.

void AddMessageParametric(string argMessageParams, string argMessageCallBackParameters);

Parameter	Type	Passing
argMessageParams	string	value
argMessageCallBackParameters	string	value

Returns: nothing (void)

BeginPreserve

No description yet.

void BeginPreserve();

Returns: nothing (void)

BeginUpdate

No description yet.

void BeginUpdate();

Returns: nothing (void)

ClearMessageByIndex

No description yet.

void ClearMessageByIndex(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: nothing (void)

ClearMessages

No description yet.

void ClearMessages();

Returns: nothing (void)

ClearMessagesForDocument

No description yet.

void ClearMessagesForDocument(string argDocumentPath);

Parameter	Type	Passing
argDocumentPath	string	value

Returns: nothing (void)

ClearMessagesOfClass

No description yet.

void ClearMessagesOfClass(string argMsgClass);

Parameter	Type	Passing
argMsgClass	string	value

Returns: nothing (void)

CreateMesssageItemDetails

No description yet.

IDXPMessageItemDetails CreateMesssageItemDetails();

Returns: IDXPMessageItemDetails

Extension method of IDXPMessagesManagerHelper (using DXP;).

EndPreserve

No description yet.

void EndPreserve();

Returns: nothing (void)

EndUpdate

No description yet.

void EndUpdate();

Returns: nothing (void)

GetMaxErrorLevel

No description yet.

TErrorLevel GetMaxErrorLevel();

Returns: TErrorLevel

Extension method of IDXPMessagesManagerHelper (using DXP;).

Messages

No description yet.

IDXPMessageItem Messages(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: IDXPMessageItem

Extension method of IDXPMessagesManagerHelper (using DXP;).

MessagesCount

No description yet.

int MessagesCount();

Returns: int

Returned by

IDXPWorkSpace.DM_MessagesManager, IWorkspace.DM_MessagesManager