Search This Blog

Thursday, September 17, 2015

How to enable the Conditional Formatting feature of the WinForms GridControl in the XAF GridListEditor and preserve ListView formatting settings between runs?

In short, this feature allows your end-user to sort or group the data inside the grid AND to visualize selected cells, rows with data bars, icons and predefined or custom appearance schemes. Refer to the following XtraGrid documentation for more information on this feature: 

In general, accomplishing this task in an XAF app consists of several independent parts:
2. Integrating this solution in the GridListEditor using a ViewController  as described in the Access Grid Control Properties  help topic.
3. Serializing the grid's formatting rules information, taking into account the fact that it uses a different mechanism for storing settings, which is based on the Application Model. In XAF, it is best to extend the ListView node with a string property that will hold a serialization representation of formatting rules. Refer to the How to: Extend the Application Model  article for more details.

This C# source file (include it into YourSolutionName.Module.Win project) illustrates how these parts can be joined together in XAF v15.1.6 ( guys can either use this approach OR convert this code into their language using free tools). It is also possible that this code can be simplified in future versions. I will try to keep this Gist updated as well as the corresponding Support Center thread.

As always, I am looking forward to hearing from you on whether you find this feature helpful for your apps.

Starting with v15.1.7+, the source code will be 3 lines simpler;-) Refer to this Support Center thread for more details.


  1. Hi, I found some null reference exception with this controller when using Xpand TreeListEditor, beware of this issue if you have custom listeditors that not descend from GridListEditor

  2. Thanks, Gustavo - I've updated the Gist accordingly.