LoadOperation<TEntity> Class

[WCF RIA Services Version 1 Service Pack 2 is compatible with either .NET framework 4 or .NET Framework 4.5, and with either Silverlight 4 or Silverlight 5.]

Represents an asynchronous load operation.

Inheritance Hierarchy

System.Object
System.ServiceModel.DomainServices.Client.OperationBase
System.ServiceModel.DomainServices.Client.LoadOperation
System.ServiceModel.DomainServices.Client.LoadOperation<TEntity>

Namespace: System.ServiceModel.DomainServices.Client
Assembly: System.ServiceModel.DomainServices.Client (in System.ServiceModel.DomainServices.Client.dll)

Syntax

'Declaration
Public NotInheritable Class LoadOperation(Of TEntity As Entity) _
    Inherits LoadOperation
'Usage
Dim instance As LoadOperation(Of TEntity)
public sealed class LoadOperation<TEntity> : LoadOperation
where TEntity : Entity
generic<typename TEntity>
where TEntity : Entity
public ref class LoadOperation sealed : public LoadOperation
[<SealedAttribute>]
type LoadOperation<'TEntity when 'TEntity : Entity> =  
    class
        inherit LoadOperation
    end
JScript does not support generic types and methods.

Type Parameters

  • TEntity
    The entity type being loaded.

The LoadOperation<TEntity> type exposes the following members.

Properties

Name Description
Public property AllEntities Gets all the entities loaded by the operation, including any entities referenced by the top-level entities. (Inherited from LoadOperation.)
Public property CanCancel Gets a value that indicates whether this OperationBase is currently in a state that enables it to be canceled. (Inherited from OperationBase.)
Public property Entities Gets all the entities loaded by the operation, including any entities referenced by the top-level entities.
Public property EntityQuery Gets the EntityQuery for this load operation.
Public property Error Gets the operation error if the operation failed. (Inherited from OperationBase.)
Public property HasError Gets a value that indicates whether the operation failed. (Inherited from OperationBase.)
Public property IsCanceled Gets a value that indicates whether this operation has been canceled. (Inherited from OperationBase.)
Public property IsComplete Gets a value that indicates whether this operation has completed. (Inherited from OperationBase.)
Public property IsErrorHandled Gets or sets a value that indicates whether the operation error has been handled. (Inherited from OperationBase.)
Public property LoadBehavior Gets the System.ServiceModel.DomainServices.Client.LoadBehavior for this load operation. (Inherited from LoadOperation.)
Protected property Result Gets the DomainClientResult for this operation. (Inherited from LoadOperation.)
Protected property SupportsCancellation Gets a value that indicates whether this operation supports cancellation. (Inherited from OperationBase.)
Public property TotalEntityCount Gets the total server entity count for the query used by this operation. (Inherited from LoadOperation.)
Public property UserState Gets the optional user state for this operation. (Inherited from OperationBase.)
Public property ValidationErrors Gets the validation errors. (Inherited from LoadOperation.)

Top

Methods

Name Description
Public method Cancel Cancels the operation. (Inherited from OperationBase.)
Protected method CancelCore When overridden in a derived class, provides the logic to cancel the operation. (Inherited from OperationBase.)
Protected method Complete(Exception) Completes a failed operation with the specified error. (Inherited from OperationBase.)
Protected method Complete(Object) Completes a successful operation with the specified result. (Inherited from OperationBase.)
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Protected method InvokeCompleteAction Invokes the completion callback. (Inherited from OperationBase.)
Public method MarkErrorAsHandled Specifies that an error encountered in an operation is handled. (Inherited from OperationBase.)
Protected method MemberwiseClone (Inherited from Object.)
Protected method OnPropertyChanged Called when the value of a property changes. (Inherited from OperationBase.)
Protected method RaisePropertyChanged Raises the System#ComponentModel#INotifyPropertyChanged#PropertyChanged() event. (Inherited from OperationBase.)
Public method ToString (Inherited from Object.)
Protected method UpdateResults Updates the observable result collections. (Inherited from LoadOperation.)

Top

Events

Name Description
Public event Completed Occurs when the operation completes. (Inherited from OperationBase.)

Top

Explicit Interface Implementations

Name Description
Explicit interface implemetationPrivate event INotifyPropertyChanged.PropertyChanged Occurs when a property value changes. (Inherited from OperationBase.)

Top

Examples

The following example shows a LoadOperation<TEntity> object that is used to populate a DataGrid with data from a query.

Imports System.Windows.Ria
Imports RIAServicesExample.Web

Partial Public Class MainPage
    Inherits UserControl

    Private _customerContext As New CustomerDomainContext

    Public Sub New()
        InitializeComponent()

        Dim loadOp = Me._customerContext.Load(Me._customerContext.GetCustomersQuery())
        CustomerGrid.ItemsSource = loadOp.Entities
    End Sub

End Class
using System;
using System.Collections.Generic;
using System.Linq;
using System.Net;
using System.Windows;
using System.Windows.Controls;
using System.Windows.Documents;
using System.Windows.Input;
using System.Windows.Media;
using System.Windows.Media.Animation;
using System.Windows.Shapes;
using RIAServicesExample.Web;
using System.Windows.Ria;

namespace RIAServicesExample
{
    public partial class MainPage : UserControl
    {
        private CustomerDomainContext _customerContext = new CustomerDomainContext();

        public MainPage()
        {
            InitializeComponent();

            LoadOperation<Customer> loadOp = this._customerContext.Load(this._customerContext.GetCustomersQuery());
            CustomerGrid.ItemsSource = loadOp.Entities;
        }
    }
}

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

System.ServiceModel.DomainServices.Client Namespace