CorrectableMessage Class

Class which is a special kind of message: a message which is correctable, through corrections contained in this message.

Inheritance Hierarchy

SystemObject
  SD.LLBLGen.Pro.ApplicationCore.MessageReportingMessage
    SD.LLBLGen.Pro.ApplicationCore.MessageReportingCorrectableMessage
      SD.LLBLGen.Pro.ApplicationCore.MessageReportingErrorMessage
      SD.LLBLGen.Pro.ApplicationCore.MessageReportingInformationMessage
      SD.LLBLGen.Pro.ApplicationCore.MessageReportingWarningMessage

Namespace: SD.LLBLGen.Pro.ApplicationCore.MessageReporting
Assembly: SD.LLBLGen.Pro.ApplicationCore (in SD.LLBLGen.Pro.ApplicationCore.dll) Version: 5.4.0.0 (5.4.0)

Syntax

Copy

public abstract class CorrectableMessage : Message

Public MustInherit Class CorrectableMessage
	Inherits Message

The CorrectableMessage type exposes the following members.

Constructors

	Name	Description
	CorrectableMessage	Initializes a new instance of the CorrectableMessage class.

Top

Properties

	Name	Description
	Corrections	Gets the list of corrections for this message
	CorrectionsAreChoices	Gets or sets a value indicating whether the contained corrections are choices (true), instead of steps (false). Choices are corrections which can have a correction func while steps ( CorrectionsAreChoices is set to false). If CorrectionsAreChoices is set to false, the message can still have corrections with their GoLocationFunc set to a value.
	CreatedOn	Gets the creation date/time (Inherited from Message.)
	IsIgnored	Gets or sets a value indicating whether this correctable message is ignored. Default false.
	MessageText	Gets the message text (Inherited from Message.)
	Source	Gets the source of the message (Inherited from Message.)
	TagCount	Gets the tag count. (Inherited from Message.)
	TypeOfMessage	Gets the type of the message. (Inherited from Message.)
	TypeOfMessageAsInt	Gets the integer value of TypeOfMessage. For databinding. (Inherited from Message.)

Top

Methods

	Name	Description
	AddCorrection(String, Int32, CorrectionActionType)	Adds a new correction with the parameter specified and no func set whatsoever.
	AddCorrection(String, Int32, Action, CorrectionActionType)	Adds a new correction with the parameter specified and the goLocation func specified.
	AddCorrection(String, Int32, FuncBoolean, CorrectionActionType)	Adds a new correction with the parameter specified and the correction func specified. If correctionFunc is not null, this message has to have CorrectionsAreChoices set to true
	AddTag	Adds the tag specified to this message. (Inherited from Message.)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetFullMessageText	Gets the full message text.
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetMessageType	Gets the type of the message.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	HasTags	Determines whether this message has any of the specified tags assigned to it. (Inherited from Message.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnHandled	Raises the Handled event (Inherited from Message.)
	OnPropertyChanged	Called when a property changed which was worth a notification (Inherited from Message.)
	PerformCorrection	Performs the correction specified. If this message is a message with steps (CorrectionsAreChoices is false), or the passed in correct isn't part of this message, an exception is thrown. If the correction is allowed to be performed and the correction has a func, the func is invoked. If the func returns true, the Handled event is raised and this message is considered handled and corrected.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Events

	Name	Description
	PropertyChanged	Occurs when a property value changes. (Inherited from Message.)

Top

Remarks

Use a CorrectableMessage to be able to specify errors and warnings

Reference

SD.LLBLGen.Pro.ApplicationCore.MessageReporting Namespace