EntityDataSource.Include Eigenschaft

Definition

Namespace:

System.Web.UI.WebControls

Assembly:

System.Web.Entity.dll

Ruft den Ausdruck ab, der die verwandten Objekte angibt, die in den Abfrageergebnissen enthalten sein sollen, oder legt diesen fest.

public:
 property System::String ^ Include { System::String ^ get(); void set(System::String ^ value); };

public string Include { get; set; }

member this.Include : string with get, set

Public Property Include As String

Eigenschaftswert

String

Durch Trennzeichen getrennte Liste von Abfragepfaden zur Rückgabe in den Abfrageergebnissen.

Beispiele

Das folgende XML-Markup definiert einen Abfragepfad, der Objekte im Zusammenhang mit dem zurückgegebenen Contact Objekt zurückgibtSalesOrderHeader. Mit jedem SalesOrderHeaderwerden auch die verknüpften SalesOrderDetail - und Address -Objekte zurückgegeben.

<asp:EntityDataSource ID="ContactDataSource" runat="server"
    AutoGenerateWhereClause="True" ConnectionString="name=AdventureWorksEntities"
    DefaultContainerName="AdventureWorksEntities" EnableDelete="True"
    EnableInsert="True" EnableUpdate="True" EntitySetName="Contact"
    Include="SalesOrderHeader.SalesOrderDetail, SalesOrderHeader.Address">
    <WhereParameters>
        <asp:ControlParameter ControlID="customerId" Name="ContactID"
            PropertyName="Text" />
    </WhereParameters>
</asp:EntityDataSource>

Das vorherige XML-Beispiel entspricht dem folgenden ObjectQuery<T> mit dem Namen customers:

ObjectQuery<Contact> customers =
      context.Contact
       .Where("it.ContactID = @ContactID",
         new ObjectParameter("ContactID", customerId))
        .Include("SalesOrderHeader.SalesOrderDetail")
        .Include("SalesOrderHeader.Address");

Hinweise

Die Include -Eigenschaft des EntityDataSource -Steuerelements gibt eine durch Trennzeichen getrennte Liste von Abfragepfaden an, die die Objekte definieren, die zusammen mit dem speziell abgefragten Objekt zurückgegeben werden. Jeder durch Trennzeichen getrennte Wert in der Zeichenfolge wird ohne Änderung als separater Aufruf der Include -Methode eines ObjectQuery<T> übergeben, der vom Entity Framework ausgeführt wird. Diese Abfrage ist die Quelle der Daten, die durch das EntityDataSource -Steuerelement reguliert werden. Die Include -Eigenschaft ist das Argument, das auf das ObjectQuery<T> angewendet wird, bevor es ausgeführt wird.

Die für die Include -Eigenschaft bereitgestellte Zeichenfolge verwendet das gleiche Format wie die Zeichenfolge, die an die Include -Methode von ObjectQuery<T>übergeben wird. Beispiele für die Verwendung von Abfragepfaden zum automatischen Laden verwandter Objekte finden Sie unter Vorgehensweise: Verwenden von Abfragepfaden zum Formen von Ergebnissen.

Wenn die Include -Eigenschaft zum Angeben von Abfragepfaden verwendet wird, können die Eigenschaften der zugehörigen Entitäten nur für die schreibgeschützte Datenbindung verwendet werden. Wenn verwandte Objekte nicht explizit im Abfragepfad enthalten sind, sind die Eigenschaftendeskriptoren weiterhin für die Datenbindung verfügbar, aber die Eigenschaften selbst geben NULL-Werte zurück. In diesem Fall müssen die verknüpften Objekte explizit geladen werden, um ihre Werte anzuzeigen. Weitere Informationen finden Sie unter Laden verknüpfter Objekte.