EntityDataSource.Include Propriété

Définition

Espace de noms:

System.Web.UI.WebControls

Assembly:

System.Web.Entity.dll

Obtient ou définit l’expression qui spécifie les objets associés à inclure dans les résultats de la requête.

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

Valeur de propriété

String

Liste séparée par des virgules des chemins de requête à retourner dans les résultats de la requête.

Exemples

Le balisage XML suivant définit un chemin d’accès de requête qui retourne SalesOrderHeader des objets liés à l’objet retourné Contact . Avec chacun d’euxSalesOrderHeader, les objets associés et Address les SalesOrderDetail objets sont également retournés.

<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>

L’exemple XML précédent est identique au nom customerssuivant ObjectQuery<T> :

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

Remarques

La Include propriété du EntityDataSource contrôle spécifie une liste séparée par des virgules de chemins d’accès de requête qui définissent les objets retournés avec l’objet spécifiquement interrogé. Chaque valeur séparée par des virgules dans la chaîne est passée, sans modification, en tant qu’appel distinct à la Include méthode d’un ObjectQuery<T> élément exécuté par Entity Framework. Cette requête est la source des données réglementées par le EntityDataSource contrôle. La Include propriété est l’argument appliqué à l’avant ObjectQuery<T> son exécution.

La chaîne fournie à la Include propriété utilise le même format que la chaîne passée à la Include méthode de ObjectQuery<T>. Pour obtenir des exemples d’utilisation des chemins de requête pour charger automatiquement des objets connexes, consultez Guide pratique pour utiliser des chemins de requête pour mettre en forme des résultats.

Lorsque la Include propriété est utilisée pour spécifier des chemins d’accès aux requêtes, les propriétés des entités associées ne peuvent être utilisées que pour la liaison de données en lecture seule. Si les objets associés ne sont pas explicitement inclus dans le chemin de requête, les descripteurs de propriété sont toujours disponibles pour la liaison de données, mais les propriétés elles-mêmes retournent des valeurs Null. Dans ce cas, les objets associés doivent être chargés explicitement pour afficher leurs valeurs. Pour plus d’informations, consultez Chargement d’objets connexes.