Share via


ModelAnnotation Class

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
Protected method ModelAnnotation Initializes a new instance of the ModelAnnotation class.

Top

Properties

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

Top

Methods

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

See Also

Reference

Microsoft.Data.Schema.SchemaModel Namespace

IModelAnnotation

IModelPropertyContainer

IModelEntity