TaskValidationMessage Class

Represents a validation error, warning, or information message.

Inheritance Hierarchy

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

Namespace:  Microsoft.VisualStudio.Modeling.Shell
Assembly:  Microsoft.VisualStudio.Modeling.Sdk.Shell.12.0 (in Microsoft.VisualStudio.Modeling.Sdk.Shell.12.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
Public method TaskValidationMessage Constructor.

Top

Properties

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

Top

Methods

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

See Also

Reference

Microsoft.VisualStudio.Modeling.Shell Namespace