Documentation Class

Definition

Namespace:

System.Data.Metadata.Edm

Assembly:

System.Data.Entity.dll

Represents the documentation associated with a conceptual model construct.

public ref class Documentation sealed : System::Data::Metadata::Edm::MetadataItem

public sealed class Documentation : System.Data.Metadata.Edm.MetadataItem

type Documentation = class
    inherit MetadataItem

Public NotInheritable Class Documentation
Inherits MetadataItem

Inheritance

Object

MetadataItem

Documentation

Remarks

The Documentation class instance represents the contents of the documentation tag defined in the conceptual schema definition language (CSDL) files and store schema definition language (SSDL) files. You can define a documentation tag for conceptual model constructs, such as the EntityContainer, the EntityType, and the ComplexType, the AssociationType. For more information, see Documentation Element (CSDL).

Properties

BuiltInTypeKind	Gets the built-in type kind for this Documentation.
Documentation	Gets or sets the documentation associated with this type. (Inherited from MetadataItem)
IsEmpty	Gets a value indicating whether this Documentation object contains only a null or an empty Summary and a LongDescription.
LongDescription	Gets the long description for this Documentation.
MetadataProperties	Gets the list of properties of the current type. (Inherited from MetadataItem)
Summary	Gets the summary for this Documentation.

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns the summary for this Documentation.