Click or drag to resize

MessageManager Class

The MessageManager class which manages message routing for the system. Use this instance to report new messages and let observers automatically get notified
Inheritance Hierarchy
SystemObject
  SD.LLBLGen.Pro.ApplicationCore.MessageReportingMessageManager

Namespace:  SD.LLBLGen.Pro.ApplicationCore.MessageReporting
Assembly:  SD.LLBLGen.Pro.ApplicationCore (in SD.LLBLGen.Pro.ApplicationCore.dll) Version: 5.11.0.0 (5.11.23.1114)
Syntax
public class MessageManager

The MessageManager type exposes the following members.

Constructors
  NameDescription
Public methodMessageManager
Initializes a new instance of the MessageManager class.
Top
Properties
  NameDescription
Public propertyContext
Public propertyCorrectableMessages
Gets the correctable messages.
Top
Methods
  NameDescription
Public methodClearCorrectableMessages
Clears the correctable messages.
Public methodClearCorrectableMessages(String)
Clears the correctable messages with the tags specified
Public methodDispatchLogNodesAsNormalMessages
Dispatches the log nodes from the tree with root rootNode as normal messages.
Public methodDispatchMessage(CorrectableMessage)
Dispatches the message specified. This leads to the message being added to the list of correctable messages.
Public methodDispatchMessage(NormalMessage)
Dispatches the message specified
Public methodDispatchNormalMessage(String, String, Object)
Dispatches a normal message with the values specified
Public methodDispatchNormalMessage(String, String, Boolean, Boolean, Object)
Dispatches a normal message with the values specified
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodRaiseGoLocationRequested
Raises the GoLocationRequested event by passing the locationData specified.
Public methodStartTaggingMessagesWithTag
Starts tagging messages with the tag specified. Only messages without any tags set are tagged with the tag specified.
Public methodStopTaggingMessagesWithTag
Stops tagging messages with the tag specified
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodUpdateIgnoredWarningIDs
Updates the ignored warning ids. The ids in the list which are currently being ignored are removed from the list. The ids which are not in the list are added to it.
Top
Events
  NameDescription
Public eventCorrectableMessageDispatched
Raised when a correctable message is dispatched through the messagemanager. The message dispatched is enclosed.
Public eventCorrectableMessageListChanged
Raised when the CorrectableMessages list was changed.
Public eventGoLocationRequested
Raised when the user has to be guided to a location, matching the data enclosed in the SourceLocationData object in the event args. Observers should interpret the SourceLocationData object's contents to navigate to the proper location in their domain.
Public eventIgnoredWarningIDsChanged
Raised when the set of warning ids changed.
Public eventNormalMessageDispatched
Raised when a normal message is dispatched through this messagemanager. The message dispatched is enclosed. Normal messages aren't added to a list of collected messages.
Top
Remarks
The MessageManager isn't thread safe as it's designed to be used on the foreground thread because it is mainly used for visualizing messages to the user. If multiple threads have to report messages, use the foreground thread to add them to this MessageManager
See Also