Skip to main content

WinForms, paging the DataGridView the right way


I know this may sound like old history, but in the enterprise world there is still a lot of WinForms development. Just a couple of days ago, I had to implement a custom DataGridView capable to work over a butt load of data (100K+ records) and keep responses times acceptables.
I thought paging will be a good way to go, and as WinForms is pretty old nowadays, I supposed it will be easy to find a couple examples on the web.
While in fact I found examples, all of them were incompletes and/or they wouldn't perform well in real world apps... So I decided to roll my own component and post it online. Hopefully, someone else will find it useful ;).


The bread and butter of this solution relies on LINQ and deferred execution. As LINQ takes care of all complicated work, it was quite easy to implement.

This component also supports conditional format, sorting and some search capabilities, but in this post I will concentrate on paging only (I'll cover the rest of the features in future posts).

I’m assuming you are familiar with LINQ (or with how partial application works in C#)

The amazing thing on how this paging implementation works, is that you only have to do a little bit of configuration and the component will take care of the rest. This is how to configure the grid.



To avoid performance killings (and to not spoil deferred execution) the row count should be specified separately.

And this is how internally works.
Configuring

Paging

Notice that when we execute the .ToList()  method we only fetch a small set of records according to the grid’s page size (we don’t fetch the whole thing). In this case instead off fetching 50K records, we are fetching only 1K and caching them for later use. If the user asks for the same page twice, the second time, we will give him a cached version of that page (we hit the database only once per page).

If the data source is mutable, when you detect a change you can invalidate the cahce and then start the whole process all over again.

You can get the code from the github repo.

Comments

  1. As we still using V10 as our development platform I just discovered that I could not rebuild this as it requires V11 :-)

    ReplyDelete
    Replies
    1. You can use VS Express 2012. It is free ;)

      Delete
  2. For those who are still working with WinForms like we, draw your attention to a good and enough cheap DataGridView alternative, 10Tec iGrid.NET control (see http://10tec.com/). As for paging, it has a FillWithData method one can use to populate the gird from an ADO.NET datasource. What is important in the context of this blog post, the parameters of the FillWithData method allow the developer to upload the data by portions - which is ideal for paging.

    ReplyDelete
    Replies
    1. Anonymous, While I'm OK with people advertising their products, please prefix them with the word _advertise _ ;)

      Delete
  3. Amiralles, thanks alot for this. I am still on winforms before I migrate my stuff to WPF and the web with MVC/ASP.NET

    ReplyDelete
    Replies
    1. Martin, thanks form reading!
      Same thing here. While on Windows, I'm still doing WinForms (enterprise stuff) but almost all companies are planing to mode their stuff to the web, so there is still hope ;)

      Delete

Post a Comment

Popular posts from this blog

Migrating an ASP.NET MVC 4 app from Azure websites to WinHost

About a week ago I've to migrate an ASP.NET MVC 4/EF5 application from Azure websites to WinHost. While the process was really smooth, there were some caveats related to database connections that I want to share with you. Create and setup the ftp profile on VS and configure the connection string was really easy, WinHost provide you those values and there is nothing special here. But once you deploy your website and try to see it online, you may get the “yellow screen of dead” with the message: "A network-related or instance-specific error occurred while establishing a connection to SQL Server. The server was not found or was not accessible. Verify that the instance name is correct and that SQL Server is configured to allow remote connections. (provider: SQL Network Interfaces, error: 26 - Error Locating Server/Instance Specified)" Assuming you wrote the connection string properly, this happens because you cannot use the default connection name in your web.c

How to show excel files inside the .NET Webbrowser Control

If you are reading this, chances are you been banging your head against the wall for a couple of hours (or even days) trying to show excel files inside the WinForms webbrowser control. Possible reasons you ended up in here: You had working code that got broke after upgrading from Win 7. Your code doesn’t work the same way between machines running different (newer) versions of IE. A download box pops up every time your app tries to show an excel file inside the webbrowser control (you wanna show the actual content). You just have no clue on how to get excel working into the .NET embedded webbrowser control. You are trying to implement IInternetSecurityManager and don’t know where to start. (Or how don’t know how to delegate calls to your security manager). Among many other, maybe….. Yes, COM is a PITA, so is ActiveX and IE (Embedded or full for that matter). And no, showing excel files inside the webbrowser control shouldn’t be that hard, but sometimes we have

How to replace text with images on Word documents using C#

This post it’s a reply to a question I got from a previous post that shows how to work with Word templates from C# code . If you haven’t read it, I recommend to do so because I’m not going into details here. But basically it was about how to create a Word document from a template and perform same text manipulation. So, the question from Marcel Kieboom  was “Do you know if it would be also possible to replace one of the words with an image which is locally stored?” The answer is yes, and this is how you can do that. Based on the same convention I had used in the previous post, I should have a template like this: What I’m trying to do here is replace the text [angus-young] for an actual pic of Angus. The technique I’m using it’s pretty common on web sites and basically consist in have an image with a matching name for each keyword I want to replace and then create the image path dynamically. This is the C# code to do that. * When I execute the f