TaskValidationMessage Class

Article
04/26/2013

Represents a validation error, warning, or information message.

Inheritance Hierarchy

Object
Microsoft.VisualStudio.Modeling.Validation.ValidationMessage
Microsoft.VisualStudio.Modeling.Shell.TaskValidationMessage

Namespace: Microsoft.VisualStudio.Modeling.Shell
Assembly: Microsoft.VisualStudio.Modeling.Sdk.Shell.11.0 (in Microsoft.VisualStudio.Modeling.Sdk.Shell.11.0.dll)

Syntax

'Declaration
Public Class TaskValidationMessage _
    Inherits ValidationMessage

public class TaskValidationMessage : ValidationMessage

public ref class TaskValidationMessage : public ValidationMessage

type TaskValidationMessage =  
    class 
        inherit ValidationMessage 
    end

public class TaskValidationMessage extends ValidationMessage

The TaskValidationMessage type exposes the following members.

Constructors

	Name	Description
	TaskValidationMessage	Constructor.

Top

Properties

	Name	Description
	Category	Task category.
	Code	Gets the code for the message. (Inherited from ValidationMessage.)
	Column	Gets the column in a line of text where the error occurs. (Inherited from ValidationMessage.)
	Context	Gets the context information for a validation message. (Inherited from ValidationMessage.)
	Description	Gets the description for a validation message. (Inherited from ValidationMessage.)
	File	return the name of the first referenced file, if one exists, otherwise null. (Overrides ValidationMessage.File.)
	HelpKeyword	Gets or sets the keyword to search for in the Help for Visual Studio. (Inherited from ValidationMessage.)
	Line	Gets the line number in the file to which the error or the warning refers. (Inherited from ValidationMessage.)
	ReferencedFiles	Gets the names of files to which the ValidationMessage refers. (Inherited from ValidationMessage.)
	ReferencedModelElements	Gets the model elements that are referenced by this message. (Inherited from ValidationMessage.)
	Type	Gets the type of validation message. (Inherited from ValidationMessage.)

Top

Methods

	Name	Description
	Configure	configures the supplied task with values of this message.
	Equals	Checks to see whether the validation message is equal to another object. (Inherited from ValidationMessage.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Gets an identifier for a ValidationMessage. (Inherited from ValidationMessage.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IsMatch(TaskItem)	determines if the specified taskItem represents this message.
	IsMatch(IVsTaskItem)	determines if the specified taskItem represents this message.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Identifies the validation message. (Inherited from ValidationMessage.)
	UpdateFileReferences(IEnumerable<String>)	Contains the names of files to update from a list of zero or more file names. (Inherited from ValidationMessage.)
	UpdateFileReferences(String)	Contains the name of the file to update. (Inherited from ValidationMessage.)
	UpdateReferencedModelElements	Updates the referenced model elements. (Inherited from ValidationMessage.)

Top

Remarks

TaskValidationMessages are supplied by the VsValidationContext, which overrides ConstructValidationMessage. It contains the information to work with the Visual Studio ErrorList tool window. It able to navigate to the shape in the diagram from the offending model element.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Share via