Your search did not match any results.
Data Grid

Collaborative Editing

Documentation

Multiple users can edit the DataGrid's data in real-time. In this demo, changes made in one DataGrid are broadcasted to the other DataGrid via the SignalR service.

To implement this functionality:

  1. Generate a session ID used to identify DataGrids that should be edited simultaneously (groupId in this demo).

  2. Configure CustomStores. In this demo, we use the createStore method (part of the DevExtreme.AspNet.data extension). The onBeforeSend function is used to send the session ID from step 1 to the server.

  3. Create store instances—one per DataGrid.

  4. Create DataGrids and bind them to the store instances.

  5. Update all the store instances when a push notification is received (see the updateStores function).

Changes made collaboratively are lost if you refresh the page because the SignalR service broadcasts changes without saving them.

Backend API
Copy to CodeSandBox
Apply
Reset
import React from 'react'; import { HubConnectionBuilder, HttpTransportType } from '@aspnet/signalr'; import * as AspNetData from 'devextreme-aspnet-data-nojquery'; import Grid from './Grid.js'; import Guid from 'devextreme/core/guid'; const BASE_PATH = 'https://js.devexpress.com/Demos/NetCore/'; const url = `${BASE_PATH }api/DataGridCollaborativeEditing`; const groupId = new Guid().toJSON(); function createStore() { return AspNetData.createStore({ key: 'ID', loadUrl: url, insertUrl: url, updateUrl: url, deleteUrl: url, onBeforeSend: function(operation, ajaxSettings) { ajaxSettings.data.groupId = groupId; } }); } const store1 = createStore(); const store2 = createStore(); function updateStores(events) { store1.push(events); store2.push(events); } class App extends React.Component { constructor(props) { super(props); } render() { return ( <div className="tables"> <div className="column"> <Grid dataSource={store1} /> </div> <div className="column"> <Grid dataSource={store2} /> </div> </div> ); } } const hubUrl = `${BASE_PATH}dataGridCollaborativeEditingHub?GroupId=${groupId}`; const connection = new HubConnectionBuilder() .withUrl(hubUrl, { skipNegotiation: true, transport: HttpTransportType.WebSockets }) .build(); connection.start() .then(function() { connection.on('update', function(key, data) { updateStores([{ type: 'update', key: key, data: data }]); }); connection.on('insert', function(data) { updateStores([{ type: 'insert', data: data }]); }); connection.on('remove', function(key) { updateStores([{ type: 'remove', key: key }]); }); }); export default App;
import React from 'react'; import DataGrid, { Column, Editing, Paging, RequiredRule, RangeRule } from 'devextreme-react/data-grid'; import * as AspNetData from 'devextreme-aspnet-data-nojquery'; class Grid extends React.Component { constructor(props) { super(props); this.maxDate = new Date(3000, 0); this.statesStore = AspNetData.createStore({ key: 'ID', loadUrl: 'https://js.devexpress.com/Demos/NetCore/api/DataGridStatesLookup' }); } render() { return ( <DataGrid dataSource={this.props.dataSource} height={600} showBorders={true} repaintChangesOnly={true} highlightChanges={true} > <Paging enabled={false} /> <Editing mode="cell" refreshMode="reshape" allowUpdating={true} allowDeleting={true} allowAdding={true} useIcons={true} /> <Column dataField="Prefix" caption="Title" width={50} > <RequiredRule /> </Column> <Column dataField="FirstName" > <RequiredRule /> </Column> <Column dataField="StateID" caption="State" lookup={{ dataSource: this.statesStore, displayExpr: 'Name', valueExpr: 'ID' }} > <RequiredRule /> </Column> <Column dataField="BirthDate" dataType="date" > <RangeRule max={this.maxDate} message="Date can not be greater than 01/01/3000" /> </Column> </DataGrid> ); } } export default Grid;
import React from 'react'; import ReactDOM from 'react-dom'; import App from './App.js'; ReactDOM.render( <App />, document.getElementById('app') );
<!DOCTYPE html> <html> <head> <title>DevExtreme Demo</title> <meta http-equiv="X-UA-Compatible" content="IE=edge" /> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0" /> <link rel="stylesheet" type="text/css" href="https://cdn3.devexpress.com/jslib/21.1.5/css/dx.common.css" /> <link rel="stylesheet" type="text/css" href="https://cdn3.devexpress.com/jslib/21.1.5/css/dx.light.css" /> <script src="https://unpkg.com/core-js@2.4.1/client/shim.min.js"></script> <script src="https://unpkg.com/systemjs@0.21.3/dist/system.js"></script> <script type="text/javascript" src="config.js"></script> <link rel="stylesheet" type="text/css" href="styles.css" /> <script type="text/javascript"> System.import('./index.js'); </script> </head> <body class="dx-viewport"> <div class="demo-container"> <div id="app"></div> </div> </body> </html>
.tables { display: flex; } .column:first-child { width: 50%; padding-right: 15px; } .column:last-child { width: 50%; padding-left: 15px; }
window.config = { transpiler: 'plugin-babel', meta: { 'devextreme/localization.js': { "esModule": true }, 'devextreme-aspnet-data-nojquery': { 'esModule': true }, }, paths: { 'npm:': 'https://unpkg.com/' }, defaultExtension: 'js', map: { 'react': 'npm:react@17.0.2/umd/react.development.js', 'react-dom': 'npm:react-dom@17.0.2/umd/react-dom.development.js', 'prop-types': 'npm:prop-types@15.7.2/prop-types.js', '@aspnet/signalr': 'npm:@aspnet/signalr@1.0.0/dist/cjs', 'tslib': 'npm:tslib@2.3.0/tslib.js', 'devextreme-aspnet-data-nojquery': 'npm:devextreme-aspnet-data-nojquery@2.8.4/index.js', 'rrule': 'npm:rrule@2.6.6/dist/es5/rrule.js', 'luxon': 'npm:luxon@1.28.0/build/global/luxon.min.js', 'es6-object-assign': 'npm:es6-object-assign@1.1.0', 'devextreme': 'npm:devextreme@21.1.5/cjs', 'devextreme-react': 'npm:devextreme-react@21.1.5', 'jszip': 'npm:jszip@3.7.0/dist/jszip.min.js', 'devextreme-quill': 'npm:devextreme-quill@1.3.1/dist/dx-quill.min.js', 'devexpress-diagram': 'npm:devexpress-diagram@2.1.25/dist/dx-diagram.js', 'devexpress-gantt': 'npm:devexpress-gantt@3.0.4/dist/dx-gantt.js', '@devextreme/vdom': 'npm:@devextreme/vdom@1.2.2', 'inferno': 'npm:inferno@7.4.8/dist/inferno.min.js', 'inferno-compat': 'npm:inferno-compat@7.4.8/dist/inferno-compat.min.js', 'inferno-create-element': 'npm:inferno-create-element@7.4.8/dist/inferno-create-element.min.js', 'inferno-dom': 'npm:inferno-dom@1.0.7/dist/inferno-dom.min.js', 'inferno-hydrate': 'npm:inferno-hydrate@7.4.8/dist/inferno-hydrate.min.js', 'inferno-clone-vnode': 'npm:inferno-clone-vnode@7.4.8/dist/inferno-clone-vnode.min.js', 'inferno-create-class': 'npm:inferno-create-class@7.4.8/dist/inferno-create-class.min.js', 'inferno-extras': 'npm:inferno-extras@7.4.8/dist/inferno-extras.min.js', // SystemJS plugins 'plugin-babel': 'npm:systemjs-plugin-babel@0.0.25/plugin-babel.js', 'systemjs-babel-build': 'npm:systemjs-plugin-babel@0.0.25/systemjs-babel-browser.js' }, packages: { 'devextreme': { defaultExtension: 'js' }, '@devextreme/vdom': { defaultExtension: 'js' }, 'devextreme-react': { main: 'index.js' }, 'devextreme/events/utils': { main: 'index' }, 'devextreme/events': { main: 'index' }, '@aspnet/signalr': { main: 'index.js', defaultExtension: 'js' }, 'es6-object-assign': { main: './index.js', defaultExtension: 'js' } }, packageConfigPaths: [ "npm:@devextreme/*/package.json", ], babelOptions: { sourceMaps: false, stage0: true, react: true } }; System.config(window.config);
using DevExtreme.AspNet.Data; using DevExtreme.AspNet.Mvc; using DevExtreme.MVC.Demos.Hubs; using DevExtreme.MVC.Demos.Models.DataGrid; using DevExtreme.MVC.Demos.Models.SampleData; using Microsoft.AspNet.SignalR; using Newtonsoft.Json; using System; using System.Net; using System.Net.Http; using System.Net.Http.Formatting; using System.Web.Http; namespace DevExtreme.MVC.Demos.Controllers.ApiControllers { public class DataGridCollaborativeEditingController : ApiController { static readonly Random random = new Random(); IHubContext hubContext; public DataGridCollaborativeEditingController() { hubContext = GlobalHost.ConnectionManager.GetHubContext<DataGridCollaborativeEditingHub>(); } [HttpGet] public object Get(DataSourceLoadOptions loadOptions) { return DataSourceLoader.Load(SampleData.DataGridEmployees, loadOptions); } [HttpPost] public HttpResponseMessage Post(FormDataCollection form) { var values = form.Get("values"); var groupId = form.Get("groupId"); var newEmployee = new Employee(); JsonConvert.PopulateObject(values, newEmployee); newEmployee.ID = random.Next(int.MaxValue); Validate(newEmployee); if(!ModelState.IsValid) { return Request.CreateErrorResponse(HttpStatusCode.BadRequest, ModelState.GetFullErrorMessage()); } // db.Employees.Add(newEmployee); // db.SaveChanges(); hubContext.Clients.Group(groupId).insert(newEmployee); return Request.CreateResponse(newEmployee); } [HttpPut] public HttpResponseMessage Put(FormDataCollection form) { var key = Convert.ToInt32(form.Get("key")); var values = form.Get("values"); var groupId = form.Get("groupId"); var employee = new Employee(); JsonConvert.PopulateObject(values, employee); employee.ID = key; Validate(employee); if(!ModelState.IsValid) { return Request.CreateErrorResponse(HttpStatusCode.BadRequest, ModelState.GetFullErrorMessage()); } // db.SaveChanges(); hubContext.Clients.Group(groupId).update(key, employee); return Request.CreateResponse(employee); } [HttpDelete] public void Delete(FormDataCollection form) { var key = Convert.ToInt32(form.Get("key")); var groupId = form.Get("groupId"); // var employee = db.Employees.First(a => a.ID == key); // db.Employees.Remove(employee); // db.SaveChanges(); hubContext.Clients.Group(groupId).remove(key); } } }
using Microsoft.AspNet.SignalR; using System.Threading.Tasks; namespace DevExtreme.MVC.Demos.Hubs { public class DataGridCollaborativeEditingHub : Hub { public override Task OnConnected() { var groupId = Context.QueryString["GroupId"]; Groups.Add(Context.ConnectionId, groupId); return base.OnConnected(); } } }