ErrorManager Class

  • Article

Manages the errors that are listed in the Error List window of Visual Studio.

Inheritance Hierarchy

System.Object
  Microsoft.Data.Schema.ErrorManager

Namespace:  Microsoft.Data.Schema
Assembly:  Microsoft.Data.Schema (in Microsoft.Data.Schema.dll)

Syntax

'Declaration
<SerializableAttribute> _
Public NotInheritable Class ErrorManager _
    Implements IDisposable, ISerializable

[SerializableAttribute]
public sealed class ErrorManager : IDisposable, 
    ISerializable

[SerializableAttribute]
public ref class ErrorManager sealed : IDisposable, 
    ISerializable

[<Sealed>]
[<SerializableAttribute>]
type ErrorManager =  
    class
        interface IDisposable
        interface ISerializable
    end

public final class ErrorManager implements IDisposable, ISerializable

The ErrorManager type exposes the following members.

Constructors

  Name Description
Public method ErrorManager Initializes a new instance of the ErrorManager class.

Top

Properties

  Name Description
Public propertyStatic member BuildCategory Gets the object that represents the build category.
Public propertyStatic member DefaultCategory Gets the object that represents the default category.
Public propertyStatic member DeployCategory Gets the object that represents the deploy category.
Public propertyStatic member ExternalsResolutionCategory Gets the object that represents the resolution category.
Public propertyStatic member ModelCategory Gets the object that represents the model category.
Public propertyStatic member ProjectPropertiesCategory Gets the object that represents the project properties category.
Public propertyStatic member ValidationAtBuildCategory Gets the object that represents the validation category.
Public propertyStatic member ValidationOnIdleCategory Gets the object that represents the validation on idle category.

Top

Methods

  Name Description
Public method Add(DataSchemaError, Object) Adds the provided DataSchemaError object to the Error List window of Visual Studio by using the specified category.
Public method Add(IList<DataSchemaError>, Object) Adds a collection of DataSchemaError objects to the Error List window of Visual Studio in the specified category.
Public method Add(DataSchemaError, Object, Boolean)
Public method Add(IList<DataSchemaError>, Object, Boolean)
Public methodStatic member AddPersistedCategory Designates that errors added to the Errors List window of Visual Studio, together with the provided category, will be persisted.
Public method ClearCategory Removes all errors that have the provided category from the Error List window of Visual Studio.
Public method Dispose Releases all resources that are used by the current instance of the ErrorManager class.
Public method Equals Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
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 Find(String, Object) Retrieves a list of all DataSchemaError objects that belong to the specified category and document.
Public method Find(Predicate<DataSchemaError>, Object)
Public method GetAllCategories Retrieves a list of all categories that exist.
Public method GetAllErrors() Retrieves a list of all errors in the ErrorManager.
Public method GetAllErrors(Object) Retrieves a list of all errors in the ErrorManager that belong to the specified category.
Public method GetCategories
Public method GetErrorCounts Retrieves the counts of errors that belong to the provided category. Counts are returned for several levels of severity.
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetObjectData Initializes a new instance of the ErrorManager class.
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method MergeWith Copies the errors from another ErrorManager object.
Public method Remove(String, Object) Removes the Error List window of Visual Studio all DataSchemaError objects from that share the provided document file name and category.
Public method Remove(DataSchemaError, Object) Removes the specified DataSchemaError object from the Error List window of Visual Studio.
Public method Remove(IList<DataSchemaError>, Object) Removes the specified DataSchemaError objects from the Error List window of Visual Studio.
Public method Remove(Predicate<DataSchemaError>, Object)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Public method UpdateErrorsDocumentName Changes the name of the document in the Document property of all DataSchemaError objects in the Error List window of Visual Studio that belong to the specified category.

Top

Events

  Name Description
Public event Disposed Occurs when the ErrorManager has been disposed.
Public event ErrorManagerRefreshed Occurs when the data in the ErrorManager has been refreshed.
Public event ErrorsChanged Occurs when one or more errors have been added or removed from the Error List window of Visual Studio.

Top

Remarks

All DataSchemaError objects are added and removed from the Error List window through this class.

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.Data.Schema Namespace

DataSchemaError

Other Resources

Error List Window