This documentation is archived and is not being maintained.

Documentation Class

Represents the documentation associated with a conceptual model construct.

System.Object
  System.Data.Metadata.Edm.MetadataItem
    System.Data.Metadata.Edm.Documentation

Namespace:  System.Data.Metadata.Edm
Assembly:  System.Data.Entity (in System.Data.Entity.dll)

public sealed class Documentation : MetadataItem

The Documentation type exposes the following members.

  NameDescription
Public propertyBuiltInTypeKindGets the built-in type kind for this Documentation. (Overrides MetadataItem.BuiltInTypeKind.)
Public propertyDocumentationGets or sets the documentation associated with this type. (Inherited from MetadataItem.)
Public propertyIsEmptyGets a value indicating whether this Documentation object contains only a null or an empty Summary and a Longdescription().
Public propertyLongDescriptionGets the long description for this Documentation.
Public propertyMetadataPropertiesGets the list of properties of the current type. (Inherited from MetadataItem.)
Public propertySummaryGets the summary for this Documentation.
Top

  NameDescription
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns the summary for this Documentation. (Overrides Object.ToString().)
Top

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, the ComplexType, the AssociationType, and so on. For more information, see Documentation (CSDL).

.NET Framework

Supported in: 4, 3.5 SP1

.NET Framework Client Profile

Supported in: 4

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

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