This documentation is archived and is not being maintained.

DataServiceContext.LoadProperty Method (Object, String)

Loads deferred content for a specified property from the data service.

Namespace:  System.Data.Services.Client
Assembly:  System.Data.Services.Client (in System.Data.Services.Client.dll)

public QueryOperationResponse LoadProperty(
	Object entity,
	string propertyName


Type: System.Object

The entity that contains the property to load.

Type: System.String

The name of the property of the specified entity to load.

Return Value

Type: System.Data.Services.Client.QueryOperationResponse
The response to the load operation.

Calling this method invokes a network operation to fetch the property value. The property specified may be any one of the properties on the entity, including properties that represent associations or links.

If the property represents an association, link or deferred property, calling this method provides the client a way to lazily load related resources.

If the entity is in the unchanged or modified state, the property value loads the related entities and marks them unchanged with unchanged links

If the property is already loaded, calling this method lets you refresh the value of the property.

The following example shows how to explicitly load the Customers object that is related to each returned Orders instance. This example uses the DataServiceContext generated by the Add Service Reference tool based on the Northwind data service, which is created when you complete the ADO.NET Data Services quickstart.

// Create the DataServiceContext using the service URI.
NorthwindEntities context = new NorthwindEntities(svcUri);

    // Enumerate over the top 10 orders obtained from the context. 
    foreach (Orders order in context.Orders.Take(10))
        // Explicitly load the customer for each order.
        context.LoadProperty(order, "Customers");

        // Write out customer and order information.
        Console.WriteLine("Customer: {0} - Order ID: {1}", 
            order.Customers.CompanyName, order.OrderID);
catch (Exception ex)
    throw new ApplicationException(
        "An error occurred during query execution.", ex);

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5 SP1