MessageHandler Attribute

Version: Available or changed with runtime version 1.0.

Specifies that the method is a MessageHandler method, which handles Message statements.

Applies To

  • Method

Note

The MessageHandler attribute can only be set inside codeunits with the SubType property set to Test.

Syntax

Version: Available or changed with runtime version 1.0.

[MessageHandler]
procedure MessageHandler(Message: Text[1024])

Important

The above signature requires the MessageHandler method to be global. For more information, see Local and global scope in AL methods.

Version: Available or changed with runtime version 2.1.

[MessageHandler]
procedure MessageHandler(Message: Text)

Important

The above signature requires the MessageHandler method to be global. For more information, see Local and global scope in AL methods.

Arguments

Message
 Type: Text[1024]
The message of the test method.

Message
 Type: Text
The message of the test method.

Remarks

The MessageHandler method is called when a message method is invoked in the code.

You use handler methods to automate tests by handling instances when user interaction is required by the code that is being tested by the test method. In these instances, the handler method is run instead of the requested user interface. The handler method should simulate the user interaction for the test case, such as validating messages, making selections, or entering values. You declare a handler type attribute on the method. For more information about handler methods, see Create Handler Methods.

See Also

AL Method Reference
Method Attributes
Test Codeunits and Test Functions