Annotation 屬性 (CSDL)

概念結構描述定義語言 (CSDL) 中的附註屬性是概念模型中自訂的 XML 屬性。除了擁有有效的 XML 結構外,下列附註屬性的條件必須成立:

  • 附註屬性不能在任何 XML 命名空間之中,這是保留供 CSDL 之用。

  • 超過一個以上的附註屬性可以套用至給定的 CSDL 項目。

  • 任兩個附註屬性的完整限定名稱不能相同。

附註屬性可用來提供與概念模型中之項目有關的額外中繼資料。在執行階段,經由使用 System.Data.Metadata.Edm 命名空間中的類別,即可存取包含在附註項目中的中繼資料。

範例

下列範例示範具有附註屬性 (CustomAttribute) 的 EntityType 項目。下列範例也顯示套用至實體類型項目的 Annotation 項目。如需詳細資訊,請參閱 Annotation 項目 (CSDL)

<Schema Namespace="SchoolModel" Alias="Self"
        xmlns:annotation="https://schemas.microsoft.com/ado/2009/02/edm/annotation"
        xmlns="https://schemas.microsoft.com/ado/2008/09/edm">
  <EntityContainer Name="SchoolEntities" annotation:LazyLoadingEnabled="true">
    <EntitySet Name="People" EntityType="SchoolModel.Person" />
  </EntityContainer>
  <EntityType Name="Person" xmlns:p="http://CustomNamespace.com"
              p:CustomAttribute="Data here.">
    <Key>
      <PropertyRef Name="PersonID" />
    </Key>
    <Property Name="PersonID" Type="Int32" Nullable="false"
              annotation:StoreGeneratedPattern="Identity" />
    <Property Name="LastName" Type="String" Nullable="false"
              MaxLength="50" Unicode="true" FixedLength="false" />
    <Property Name="FirstName" Type="String" Nullable="false"
              MaxLength="50" Unicode="true" FixedLength="false" />
    <Property Name="HireDate" Type="DateTime" />
    <Property Name="EnrollmentDate" Type="DateTime" />
    <p:CustomElement>
      Custom metadata.
    </p:CustomElement>
  </EntityType>
</Schema>

下列程式碼會擷取附註屬性中的中繼資料,並且將它撰寫至主控台:

Dim collection As New EdmItemCollection("School.csdl")
Dim workspace As New MetadataWorkspace()
workspace.RegisterItemCollection(collection)
Dim contentType As EdmType
workspace.TryGetType("Person", "SchoolModel", DataSpace.CSpace, contentType)
If contentType.MetadataProperties.Contains("http://CustomNamespace.com:CustomAttribute") Then
    Dim annotationProperty As MetadataProperty = _
        contentType.MetadataProperties("http://CustomNamespace.com:CustomAttribute")
    Dim annotationValue As Object = annotationProperty.Value
    Console.WriteLine(annotationValue.ToString())
End If
EdmItemCollection collection = new EdmItemCollection("School.csdl");
MetadataWorkspace workspace = new MetadataWorkspace();
workspace.RegisterItemCollection(collection);
EdmType contentType;
workspace.TryGetType("Person", "SchoolModel", DataSpace.CSpace, out contentType);
if (contentType.MetadataProperties.Contains("http://CustomNamespace.com:CustomAttribute"))
{
    MetadataProperty annotationProperty =
        contentType.MetadataProperties["http://CustomNamespace.com:CustomAttribute"];
    object annotationValue = annotationProperty.Value;
    Console.WriteLine(annotationValue.ToString());
}

以上程式碼假設 School.csdl 檔位於專案的輸出目錄中,而且您已將下列 Imports 和 Using 陳述式加入至專案:

Imports System.Data.Metadata.Edm
using System.Data.Metadata.Edm;

請參閱

概念

Annotation 項目 (CSDL)

CSDL 規格

其他資源

CSDL、SSDL 和 MSL 規格