OnRegister Method (Message)

In This Topic

Called by EPLAN when the new project message is added to the system. If a new project message was added to a registered add-in, the add-in must be registered over again.

Syntax

C#
C++/CLI

public abstract void OnRegister( 
   ref string strCreator,
   ref IMessage.Region eRegion,
   ref int iMessageId,
   ref IMessage.Classification eClassification,
   ref int iOrdinal
)

public:
abstract void OnRegister( 
   String^% strCreator,
   IMessage.Region% eRegion,
   int% iMessageId,
   IMessage.Classification% eClassification,
   int% iOrdinal
)

Parameters

strCreator
eRegion: The new project message will be added to this IMessage.Region. Add\-ins should be use region ePRJMSG_REGION_EXTERNALS.
iMessageId: serial number inside the chosen region
eClassification: Default IMessage.Classification of the new message. The IMessage.Classification could be changed in the project setting dialog at run time.
iOrdinal: The new message could overwrite an existing message which has the same IMessage.Region and the same iMessageId, if the ordinal number of the new message is higher. (default\: 20)

Remarks

By overriding an existing message, it is only possible to change the message text, but not the classification etc.

Reference

Message Class
Message Members

Send Feedback