WcfServerModeSource Class

The data source for the GridControl and SearchLookUpEdit controls that binds these controls to a WCF Data Service in Server Mode.

Namespace: DevExpress.Data.WcfLinq

Assembly: DevExpress.Data.v18.1.dll

Declaration

C#

[ToolboxTabName("DX.18.1: Data & Analytics")]
[ToolboxBitmap(typeof(ResFinder), "Bitmaps256.WcfServerModeSource.bmp")]
public class WcfServerModeSource :
    Component,
    IListSource,
    ISupportInitialize,
    IWcfServerModeFrontEndOwner,
    IDXCloneable

VB.NET

<ToolboxTabName("DX.18.1: Data & Analytics")>
<ToolboxBitmap(GetType(ResFinder), "Bitmaps256.WcfServerModeSource.bmp")>
Public Class WcfServerModeSource
    Inherits Component
    Implements IListSource,
               ISupportInitialize,
               IWcfServerModeFrontEndOwner,
               IDXCloneable

Remarks

Server mode allows a data-aware control to rapidly work with large datasets. Loading records in small portions on demand and performing data-aware operations on the data server side are the key features of server mode. When the control needs to display a specific portion of data, it calls a specific method of the bound server mode data source. This method sends a corresponding request to the data store, and upon receiving the results, passes them back to the control. The WcfServerModeSource component implements the IListSource interface, and can be used as a data source for a control supporting the server mode feature.

Use WcfServerModeSource to bind a server-mode enabled control to a WCF Data Service. Specify the type of objects contained in the query result using the WcfServerModeSource.ElementType property. Specify the required query request to a WCF Data Service via the WcfServerModeSource.Query property. Bind the control to the WcfServerModeSource component.

C#

public MainWindow() {
    InitializeComponent();
    grid.DataSource = new WcfServerModeSource() {        
        KeyExpression = "CustomerID",
        Query = myDataServiceContext.Customers
    };
}

VB.NET

Public Sub New()
    InitializeComponent()
    grid.DataSource = New WcfServerModeSource() With { _
    .KeyExpression = "CustomerID", _
    .Query = myDataServiceContext.Customers}
End Sub

You can see a detailed example in the How to use the WcfServerModeSource component as a data source article.

Note

WcfServerModeSource is a read-only data source.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the WcfServerModeSource class.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-use-wcf-data-services-to-bind-gridview-extension-to-data-t157165/CS/WebApplication/Controllers/HomeController.cs#L21

public ActionResult GridViewPartial() {
    var model = GetWcfDataSource();
    return PartialView("_GridViewPartial", model);

how-to-implement-crud-operations-using-xtragrid-and-wcfservermodesource-e4503/CS/Example/MainForm.cs#L29

private NorthwindEntities context;
WcfServerModeSource wSMS;
private Customers newCustomer;

VB.NET

how-to-implement-crud-operations-using-xtragrid-and-wcfservermodesource-e4503/VB/Example/MainForm.vb#L32

Private context As NorthwindEntities
Private wSMS As WcfServerModeSource
Private newCustomer As Customers

how-to-use-wcf-data-services-to-bind-gridview-extension-to-data-t157165/VB/WebApplication/Controllers/HomeController.vb#L27

Private Function GetWcfDataSource() As WcfServerModeSource
    Return New WcfServerModeSource() With {.KeyExpression = "OrderID", .Query = db.Orders.Expand(Function(q) q.Customer).Expand(Function(q) q.Shipper)}

Inheritance

Object

MarshalByRefObject

Component

WcfServerModeSource