Documentation Class

Documentation Class

.NET Framework (current version)
 

Represents the documentation associated with a conceptual model construct.

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

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

public sealed class Documentation : MetadataItem

NameDescription
System_CAPS_pubpropertyBuiltInTypeKind

Gets the built-in type kind for this Documentation.(Overrides MetadataItem.BuiltInTypeKind.)

System_CAPS_pubpropertyDocumentation

Gets or sets the documentation associated with this type.(Inherited from MetadataItem.)

System_CAPS_pubpropertyIsEmpty

Gets a value indicating whether this Documentation object contains only a null or an empty Summary and a P:System.Data.Metadata.Edm.Documentation.Longdescription.

System_CAPS_pubpropertyLongDescription

Gets the long description for this Documentation.

System_CAPS_pubpropertyMetadataProperties

Gets the list of properties of the current type.(Inherited from MetadataItem.)

System_CAPS_pubpropertySummary

Gets the summary for this Documentation.

NameDescription
System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodToString()

Returns the summary for this Documentation.(Overrides Object.ToString().)

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 Element (CSDL).

.NET Framework
Available since 3.5

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:
© 2016 Microsoft