Documentation Documentation Documentation Documentation Class

Definition

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
DocumentationDocumentationDocumentationDocumentation

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

Properties

BuiltInTypeKind BuiltInTypeKind BuiltInTypeKind BuiltInTypeKind

Gets the built-in type kind for this Documentation.

Documentation Documentation Documentation Documentation

Gets or sets the documentation associated with this type.

(Inherited from MetadataItem)
IsEmpty IsEmpty IsEmpty IsEmpty

Gets a value indicating whether this Documentation object contains only a null or an empty Summary and a LongDescription.

LongDescription LongDescription LongDescription LongDescription

Gets the long description for this Documentation.

MetadataProperties MetadataProperties MetadataProperties MetadataProperties

Gets the list of properties of the current type.

(Inherited from MetadataItem)
Summary Summary Summary Summary

Gets the summary for this Documentation.

Methods

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetType() GetType() GetType() GetType()

Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

Returns the summary for this Documentation.

Applies to