ModelAnnotation Class

Article
2012-11-05

Represents an annotation that is attached to a schema model element.

Inheritance Hierarchy

System.Object
  Microsoft.Data.Schema.SchemaModel.ModelAnnotation
    Microsoft.Data.Schema.Sql.SchemaModel.DacProjectAnnotation
    Microsoft.Data.Schema.Sql.SchemaModel.SqlInlineConstraintAnnotation
    Microsoft.Data.Schema.Sql.SchemaModel.SysCommentsObjectAnnotation
    Microsoft.Data.Schema.Tools.DataGenerator.ColumnConfigAnnotation

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

Syntax

'Declaration
Public MustInherit Class ModelAnnotation _
    Implements IModelAnnotation, IModelPropertyContainer, IModelEntity

public abstract class ModelAnnotation : IModelAnnotation, 
    IModelPropertyContainer, IModelEntity

public ref class ModelAnnotation abstract : IModelAnnotation, 
    IModelPropertyContainer, IModelEntity

[<AbstractClass>]
type ModelAnnotation =  
    class
        interface IModelAnnotation
        interface IModelPropertyContainer
        interface IModelEntity
    end

public abstract class ModelAnnotation implements IModelAnnotation, IModelPropertyContainer, IModelEntity

The ModelAnnotation type exposes the following members.

Constructors

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

Top

Properties

	Name	Description
	AnnotationClass	Gets the metadata object that describes this instance.
	IsAttachedToStore	Gets a value that indicates whether the annotation is attached to a ModelStore.
	Model	Gets or sets the ModelStore.
	Name	Gets or sets the annotation name.

Top

Methods

	Name	Description
	Delete	Deletes this instance from the schema model.
	Equals	Returns a value that indicates whether a provided object is equal to the current object. (Overrides Object.Equals(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.)
	GetElements	Returns a list of elements in this instance.
	GetHashCode	Not required. (Overrides Object.GetHashCode().)
	GetProperty<TProperty>	Retrieves a specified property.
	GetRelationshipEntries	Returns the relationship entries to which this annotation is attached.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IsDeleted	Returns a value that indicates whether this instance has been deleted.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	RegisterAnnotationClass<TAnnotation>	Registers the provided annotation type together with the annotation.
	RegisterPropertyClass<TProperty>	Registers a property type that has the annotation.
	SetProperty<TProperty>	Sets the value of the provided property.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

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