Dela via

Kommentera inskrivna datauppsättningar

Med anteckningar kan du ändra namnen på elementen i det angivna DataSet utan att ändra det underliggande schemat. Om du ändrar namnen på elementen i det underliggande schemat skulle det som skrivs DataSet referera till objekt som inte finns i datakällan och förlora en referens till de objekt som finns i datakällan.

Med hjälp av anteckningar kan du anpassa namnen på objekten i dina inskrivna DataSet med mer meningsfulla namn, vilket gör koden mer läsbar och din inskrivna DataSet enklare för klienter att använda, samtidigt som det underliggande schemat lämnas intakt. Följande schemaelement för Customers databasens Northwind tabell skulle till exempel resultera i ett DataRow objektnamn CustomersRow och ett DataRowCollection med namnet Kunder.

<xs:element name="Customers">
  <xs:complexType>
    <xs:sequence>
      <xs:element name="CustomerID" type="xs:string" minOccurs="0" />
    </xs:sequence>
  </xs:complexType>
</xs:element>

Ett DataRowCollection namn på Customers är meningsfullt i klientkoden, men ett DataRow namn CustomersRow på är missvisande eftersom det är ett enda objekt. I vanliga scenarier skulle objektet också refereras till utan identifieraren Row och skulle i stället bara kallas för ett Customer objekt. Lösningen är att kommentera schemat och identifiera nya namn för objekten DataRow och DataRowCollection . Följande är den kommenterade versionen av föregående schema.

<xs:element name="Customers" codegen:typedName="Customer" codegen:typedPlural="Customers">
  <xs:complexType>
    <xs:sequence>
      <xs:element name="CustomerID" type="xs:string" minOccurs="0" />
    </xs:sequence>
  </xs:complexType>
</xs:element>

Om du anger värdet typedName för Customer resulterar det i ett DataRow objektnamn för kunden. Om du specificerar ett värde för typedPlural av Customers bevaras namnet DataRowCollection för Kunder.

I följande tabell visas de anteckningar som är tillgängliga för användning.

Anteckning Beskrivning
typedName Namnet på objektet.
typedPlural Namn på en samling objekt.
typedParent Namnet på objektet när det refereras till i en överordnad relation.
typedChildren Metodens namn för att returnera objekt från en barnrelation.
nullValue Värde om det underliggande värdet är DBNull. Se följande tabell för nullValue anteckningar. Standardvärdet är _throw.

I följande tabell visas de värden som kan anges för anteckningen nullValue .

nullValue-värde Beskrivning
Ersättningsvärde Ange ett värde som ska returneras. Det returnerade värdet måste matcha elementtypen. Använd till exempel nullValue="0" för att returnera 0 för null-heltalsfält.
_kasta Kasta ett undantag. Det här är standardinställningen.
_noll Returnera en null-referens eller generera ett undantag om en primitiv typ påträffas.
_tom För strängar returnerar du String.Empty, annars returnerar du ett objekt som skapats från en tom konstruktor. Om en primitiv typ påträffas utlöser du ett undantag.

I följande tabell visas standardvärden för objekt i en angiven DataSet och tillgängliga anteckningar.

Objekt/metod/händelse Förinställning Anteckning
DataTable TableNameDataTable typedPlural
DataTable Metoder NewTableNameRow

LäggTillTabellnamnRad

Radera rad från tabellnamn		 typedName
DataRowCollection Tabellnamn typedPlural
DataRow TableNameRow typedName
DataColumn DataTable.ColumnNameColumn

DataRow.ColumnName		 typedName
Fastighet Egenskapsnamn typedName
Barn Accessor GetChildTableNameRows typade barn
Förälder Accessor TableNameRow typedParent
DataSet Evenemang TableNameRowChangeEvent

TableNameRowChangeEventHandler		 typedName

Om du vill använda inskrivna DataSet anteckningar måste du inkludera följande xmlns referens i XSD-schemat (XML Schema Definition Language). Information om hur du skapar en xsd från databastabeller finns i WriteXmlSchema eller Hantera datauppsättningar i Visual Studio.

xmlns:codegen="urn:schemas-microsoft-com:xml-msprop"

Följande är ett exempel på ett kommenterat schema som exponerar Customers tabellen i Northwind databasen med en relation till tabellen Orders som ingår.

<?xml version="1.0" encoding="utf-8"?>
<xs:schema id="CustomerDataSet"
      xmlns:codegen="urn:schemas-microsoft-com:xml-msprop"
      xmlns=""
      xmlns:xs="http://www.w3.org/2001/XMLSchema"
      xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
  <xs:element name="CustomerDataSet" msdata:IsDataSet="true">
    <xs:complexType>
      <xs:choice maxOccurs="unbounded">
        <xs:element name="Customers" codegen:typedName="Customer" codegen:typedPlural="Customers">
          <xs:complexType>
            <xs:sequence>
              <xs:element name="CustomerID"
codegen:typedName="CustomerID" type="xs:string" minOccurs="0" />
              <xs:element name="CompanyName"
codegen:typedName="CompanyName" type="xs:string" minOccurs="0" />
              <xs:element name="Phone" codegen:typedName="Phone" codegen:nullValue="" type="xs:string" minOccurs="0" />
            </xs:sequence>
          </xs:complexType>
        </xs:element>
        <xs:element name="Orders" codegen:typedName="Order" codegen:typedPlural="Orders">
          <xs:complexType>
            <xs:sequence>
              <xs:element name="OrderID" codegen:typedName="OrderID"
type="xs:int" minOccurs="0" />
              <xs:element name="CustomerID"
codegen:typedName="CustomerID"                  codegen:nullValue="" type="xs:string" minOccurs="0" />
              <xs:element name="EmployeeID"
codegen:typedName="EmployeeID" codegen:nullValue="0"
type="xs:int" minOccurs="0" />
              <xs:element name="OrderAdapter"
codegen:typedName="OrderAdapter" codegen:nullValue="1980-01-01T00:00:00"
type="xs:dateTime" minOccurs="0" />
            </xs:sequence>
          </xs:complexType>
        </xs:element>
      </xs:choice>
    </xs:complexType>
    <xs:unique name="Constraint1">
      <xs:selector xpath=".//Customers" />
      <xs:field xpath="CustomerID" />
    </xs:unique>
    <xs:keyref name="CustOrders" refer="Constraint1"
codegen:typedParent="Customer" codegen:typedChildren="GetOrders">
      <xs:selector xpath=".//Orders" />
      <xs:field xpath="CustomerID" />
    </xs:keyref>
  </xs:element>
</xs:schema>

I följande kodexempel används ett starkt typat objekt som skapats DataSet från exempelschemat. Den använder en SqlDataAdapter för att fylla i Customers tabellen och en annan SqlDataAdapter för att fylla i Orders tabellen. Den starkt inskrivna DataSet definierar DataRelations.

' Assumes a valid SqlConnection object named connection.
Dim customerAdapter As SqlDataAdapter = New SqlDataAdapter( _
    "SELECT CustomerID, CompanyName, Phone FROM Customers", &
    connection)
Dim orderAdapter As SqlDataAdapter = New SqlDataAdapter( _
    "SELECT OrderID, CustomerID, EmployeeID, OrderAdapter FROM Orders", &
    connection)

' Populate a strongly typed DataSet.
connection.Open()
Dim customers As CustomerDataSet = New CustomerDataSet()
customerAdapter.Fill(customers, "Customers")
orderAdapter.Fill(customers, "Orders")
connection.Close()

' Add a strongly typed event.
AddHandler customers.Customers.CustomerChanged, &
    New CustomerDataSet.CustomerChangeEventHandler( _
    AddressOf OnCustomerChanged)

' Add a strongly typed DataRow.
Dim newCustomer As CustomerDataSet.Customer = _
    customers.Customers.NewCustomer()
newCustomer.CustomerID = "NEW01"
newCustomer.CompanyName = "My New Company"
customers.Customers.AddCustomer(newCustomer)

' Navigate the child relation.
Dim customer As CustomerDataSet.Customer
Dim order As CustomerDataSet.Order

For Each customer In customers.Customers
  Console.WriteLine(customer.CustomerID)
  For Each order In customer.GetOrders()
    Console.WriteLine(vbTab & order.OrderID)
  Next
Next

Private Shared Sub OnCustomerChanged( _
    sender As Object, e As CustomerDataSet.CustomerChangeEvent)

End Sub

// Assumes a valid SqlConnection object named connection.
SqlDataAdapter customerAdapter = new SqlDataAdapter(
    "SELECT CustomerID, CompanyName, Phone FROM Customers",
    connection);
SqlDataAdapter orderAdapter = new SqlDataAdapter(
    "SELECT OrderID, CustomerID, EmployeeID, OrderAdapter FROM Orders",
    connection);

// Populate a strongly typed DataSet.
connection.Open();
CustomerDataSet customers = new CustomerDataSet();
customerAdapter.Fill(customers, "Customers");
orderAdapter.Fill(customers, "Orders");
connection.Close();

// Add a strongly typed event.
customers.Customers.CustomerChanged += new
  CustomerDataSet.CustomerChangeEventHandler(OnCustomerChanged);

// Add a strongly typed DataRow.
CustomerDataSet.Customer newCustomer =
    customers.Customers.NewCustomer();
newCustomer.CustomerID = "NEW01";
newCustomer.CompanyName = "My New Company";
customers.Customers.AddCustomer(newCustomer);

// Navigate the child relation.
foreach(CustomerDataSet.Customer customer in customers.Customers)
{
  Console.WriteLine(customer.CustomerID);
  foreach(CustomerDataSet.Order order in customer.GetOrders())
    Console.WriteLine("\t" + order.OrderID);
}

protected static void OnCustomerChanged(object sender, CustomerDataSet.CustomerChangeEvent e)
    {

    }

Se även

  • Last updated on