This documentation is archived and is not being maintained.

DataServiceContext.BeginLoadProperty Method (Object, String, AsyncCallback, Object)

Asynchronously loads the value of the specified property from the data service.

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

public IAsyncResult BeginLoadProperty(
	Object entity,
	string propertyName,
	AsyncCallback callback,
	Object state


Type: System.Object
The entity that contains the property to load.
Type: System.String
The name of the property on the specified entity to load.
Type: System.AsyncCallback
The delegate called when a response to the request is received.
Type: System.Object
The user-defined state object that is used to pass context data to the callback method.

Return Value

Type: System.IAsyncResult
An IAsyncResult that represents the status of the asynchronous operation.

Calling this method invokes a network operation to retrieve the value of a property. The property specified may be any one of the properties on an entity, including properties which represent associations or links. If the property represents an association or link or a deferred property, calling this method provides the client with a way to lazily load related resources. If the entity is in the modified state, the property value loads related entities and marks them and any links as unchanged.

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

.NET Framework

Supported in: 4, 3.5 SP1

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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