ValidationController Class

 

Contains logic to validate a single model element or all model elements in a store or partition.

Namespace:   Microsoft.VisualStudio.Modeling.Validation
Assembly:  Microsoft.VisualStudio.Modeling.Sdk.12.0 (in Microsoft.VisualStudio.Modeling.Sdk.12.0.dll)

System::Object
  Microsoft.VisualStudio.Modeling.Validation::ValidationController
    Microsoft.VisualStudio.Modeling.Shell::VsValidationController

public ref class ValidationController 

NameDescription
System_CAPS_pubmethodValidationController()

Creates a new instance of the ValidationController class.

NameDescription
System_CAPS_pubpropertyErrorMessages

Gets a copy of all the active error and fatal messages.

System_CAPS_pubpropertyFatalMessages

Gets a copy of all the active fatal messages.

System_CAPS_pubpropertyIncludeLinkedExtensionElements

Indicates whether ExtensionElements linked to the ModelElements being validated should also be validated. ExtensionElements allow a DSL definition to be extended by a third party.

System_CAPS_pubpropertyInformationalMessages

gets a copy of all the active informational messages.

System_CAPS_pubpropertyValidationExtensionRegistrar

Property for ValidationExtension Registrar

System_CAPS_pubpropertyValidationMessages

Gets the validation messages for the controller.

System_CAPS_pubpropertyWarningMessages

Gets a copy of all the active warning messages.

NameDescription
System_CAPS_pubmethodAddObserver(ValidationMessageObserver^)

Adds an observer to the list of observers for the controller. The observer will be notified when a message is added to or removed from the list for this controller.

System_CAPS_pubmethodClearMessages()

Removes all error and warning messages from the controller.

System_CAPS_protmethodCreateValidationContext(IEnumerable<ModelElement^>^, array<String^>^)

Create a context for validation of a collection of model elements. Every validation method that belongs to any of the specified custom categories will be applied to every element in the subjects list.

System_CAPS_protmethodCreateValidationContext(IEnumerable<ModelElement^>^, ValidationCategories)

Creates a validation context for validation of a list of elements.

System_CAPS_pubmethodEquals(Object^)

(Inherited from Object.)

System_CAPS_protmethodFinalize()

(Inherited from Object.)

System_CAPS_protmethodGetExtensionElements(IEnumerable<ModelElement^>^)

Calculates and returns a list of extension elements that should be included in the list of elements being validated

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethodRemoveObserver(ValidationMessageObserver^)

Removes the observer from the list of observers for the controller.

System_CAPS_pubmethodToString()

(Inherited from Object.)

System_CAPS_pubmethodValidate(IEnumerable<ModelElement^>^, ValidationCategories)

Apply validation methods to every model element in a list. Methods will be invoked that have a ValidationMethod attribute for one or more of the specified Categories.

System_CAPS_pubmethodValidate(ModelElement^, ValidationCategories)

Do validation for a single element, invoking validation methods that have ValidationMethod attributes for one or more of the specified validation categories.

System_CAPS_pubmethodValidate(Partition^, ValidationCategories)

Apply validation to every element in the specified partition, invoking validation methods that have ValidationMethod attributes for one or more of the specified categories.

System_CAPS_pubmethodValidate(Store^, ValidationCategories)

Apply validation to every element in the Store, invoking methods that have ValidationMethod attributes for one or more of the specified categories.

System_CAPS_pubmethodValidateCustom(IEnumerable<ModelElement^>^, array<String^>^)

Apply validation methods to each element in the collection. Each validation method in any of the chosen categories is applied to each element in the list. A validation method is in a category if it has a ValidationMethod attribute that specifies the category.

System_CAPS_pubmethodValidateCustom(ModelElement^, array<String^>^)

Validates the specified model element using validation methods in the specified custom validation categories.

System_CAPS_pubmethodValidateCustom(Partition^, array<String^>^)

Validates the model elements in a partition for the specified custom validation categories.

System_CAPS_pubmethodValidateCustom(Store^, array<String^>^)

Validates every model elements in a store, using validation methods in the specified custom categories. A validation method belongs to a category if it has a ValidationMethod attribute specifying that category.

A ValidationController is created if you enable any validation setting in the model.

For example, this XML element in the DslDefinition file (the .dsl file) enables validation and creates a ValidationController object:

<Validation UsesOpen="true" UsesMenu="true" UsesSave="true" UsesCustom="false" />

You can derive a class from ValidationController and register to be notified of validation events.

For more information, see Validation in a Domain-Specific Language.

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

Return to top
Show: