This topic provides information on breaking changes that were made to WebGrid. As developers using WebGrid, you should be aware of these changes before upgrading your version of the NetAdvantage for ASP.NET product.

2007 Volume 2

If you are upgrading your existing ASP.NET project to 2007 Volume 2, take note of the following breaking changes that were made to WebGrid.

Renamed Style Properties

Some style properties in WebGrid's DisplayLayout and Band objects have been marked as obsolete. This change was necessary to avoid problems with Microsoft® Visual Studio® 2005 serializing properties named Style at design time. The simplest and easiest work around is to set any WebGrid property at design time after upgrading an existing project to 2007 Volume 2. This action ensures that the old properties are renamed automatically when WebGrid is serialized to the Web form.

Note: Although your Web project will compile and run, you will get a warning message when setting any of these properties at run time. You should use the new property name to avoid any future issues because the old properties will eventually be removed from WebGrid. In addition, the old property names are not shown in Visual Studio's IntelliSense™.

The following properties (listed in alphabetical order) have been renamed:

Prior to 2007 Volume 2	In 2007 Volume 2 and later
AddNewBox.Style	AddNewBox.BoxStyle
AddNewRow.Style	AddNewRow.RowStyle
GroupByBox.Style	GroupByBox.BoxStyle
Pager.Style	Pager.PagerStyle

Removed CaseSensitiveSort Property

WebGrid's CaseSensitiveSort client-side property has been removed. You should use the column object's SortCaseSensitive client-side property instead.

2007 Volume 1

If you are upgrading your existing ASP.NET project to 2007 Volume 1, take note of the following breaking changes that were made to WebGrid.

Applying Styles Using Cascading Style Sheets (CSS)

If you are using CSS to set certain styles for your WebGrid, they may not appear as expected from reading the CSS definition. This is most commonly encountered when upgrading an existing ASP.NET project, using an earlier version of the NetAdvantage for ASP.NET controls, to 2007 Volume 1. However, it can also happen when creating new Web applications. These changes to WebGrid were required to make the control work with the Application Styling Framework™ (ASF).

Prior to 2007 Volume 1, when using the CssClass properties on Style objects, WebGrid would determine the "lowest common" style for a particular element and apply only that specific CssClass to the element. However, with the introduction of the ASF, we've implemented the ability to have multiple CSS classes to the same element and layer them in proper order.

When applying multiple CSS classes to the same element, standard HTML cascading rules are applied. If two rules have the same importance, origin and specificity, the last rule specified is the one that takes precedence. For WebGrid, this means that if you are setting multiple CssClass properties that can apply to a specific element, they are applied in the order they are found in your CSS file. The latest rule will always override any rule applied earlier in the file.

For more information on CSS cascading order rules, see Section 6 of the CSS2 Specification on the World Wide Web Consortium's Web site.

Note: For a basic overview of the order in which styles are applied to WebGrid, see WebGrid Style Inheritance.

Consider the following scenario in which WebGrid has specific styles applied to it:

In Visual Basic:

Me.UltraWebGrid1.DisplayLayout.RowStyleDefault.CssClass = "RowStyle"
Me.UltraWebGrid1.DisplayLayout.RowAlternateStyleDefault.CssClass = "RowAltStyle"
Me.UltraWebGrid1.DisplayLayout.HeaderStyleDefault.CssClass = "HeaderStyle"

In C#:

this.UltraWebGrid1.DisplayLayout.RowStyleDefault.CssClass = "RowStyle";
this.UltraWebGrid1.DisplayLayout.RowAlternateStyleDefault.CssClass = "RowAltStyle";
this.UltraWebGrid1.DisplayLayout.HeaderStyleDefault.CssClass = "HeaderStyle";

Prior to 2007 Volume 1, you could apply the following CSS because the order in which the classes are defined didn't matter:

Note: This CSS is not correct for 2007 Volume 1 and later.

In CSS:

.RowAltStyle{background-color:White;}
.RowStyle{background-color:Blue;}
.HeaderStyle{background-color:Green;}

This CSS would cause all your rows to have a blue background, and your header to have a green background. However, the alternate rows would not appear with a white background.

If you want your alternate rows to appear with a white background, use the following CSS definition instead:

Note: This CSS is correct for 2007 Volume 1 and later.

In CSS:

.RowStyle{background-color:Blue;}
.RowAltStyle{background-color:White;}
.HeaderStyle{background-color:Green;}

Using a Local Image for the BackgroundImage

Note: This change affects only certain types of image settings such as setting a background image on a style object. Other image settings for WebGrid have always worked correctly and should not be affected by this change.

If you are setting the BackgroundImage from any style object using a local image, you need to specify that it is a local image by prepending it with a "./" in front of it. Otherwise, it will resolve to the /ig_common/Images/ path. This change was made to bring WebGrid into consistent compliance with the rest of the NetAdvantage for ASP.NET controls.

For example, if you are setting this property for WebGrid's RowStyleDefault using a local image named myimage.gif, you should use the following example code:

In Visual Basic:

Me.UltraWebGrid1.DisplayLayout.RowStyleDefault.BackgroundImage = "./myimage.gif"

In C#:

this.UltraWebGrid1.DisplayLayout.RowStyleDefault.BackgroundImage = "./myimage.gif";

Note: In Microsoft Visual Studi® 2005 (.NET Framework 2.0), if you created your Web site as a File System, you will not see the image(s) applied from the /ig_common/Images/ path. This is due to the fact that a File System Web site creates its own virtual directory instead of using IIS.

Other

The FixedColumnScrollType property can no longer be set to Column, as Column has been removed from the available enumerations.
Note: The following breaking change applies only to the NetAdvantage for .NET 2007.1 hotfix build 1045 (hotfix version 7.1.20071.1045)
Cascading Style Sheets (CSS) classes are now rendered in the Web page's HEAD element. If you want the WebGrid control to override your CSS classes, it is recommended that you move the CSS classes into the HEAD element. For more information, see Breaking Changes (Multiple Controls).

2006 Volume 3

If you are upgrading your existing ASP.NET project to 2006 Volume 3, take note of the following breaking changes that were made to WebGrid. These breaking changes occurred while addressing issues involving themes in CLR 2.0.

The setter properties have been removed from the Styles object in WebGrid. Therefore, programs that create and assign GridItemStyle objects may fail.
The style information for the FilterOption object has been moved to the preset rather then being set by the control. This could be an issue if you are creating your WebGrid at run time or don't allow a preset to be applied. If you do one of these two things, your drop-down filter list will be transparent and unstyled, because you did not apply a style when you created it.

Note: You may encounter an error message indicating that a particular set method cannot be found. If so make sure your application isn't caching itself. To ensure this, clear your Temporary ASP.NET files in your installed framework (i.e., C:\Windows\Microsoft.NET\Framework\<version>\Temporary ASP.NET files).

2006 Volume 1

If you are upgrading your existing ASP.NET project to 2006 Volume 1, take note of the following breaking changes that were made to WebGrid. These breaking changes were created due to performance improvements made to WebGrid.

Row, Column, and Cell IDs Changed -- The row, column, and cell IDs have been changed to use a better naming schema that is easier to follow. Below are examples of the new schema. gridname is the name of the WebGrid that the row, column, or cell is associated with.
- row ID: gridname_r_0
- cell ID: gridname_rc_0_0
- column ID: gridname_c_0_0
Cell IDs are Now Created Dynamically -- The cell IDs are not present in the grid's HTML footprint anymore. They are created dynamically on the client from their row IDs whenever the row or cell is requested.
Note: Cell IDs are generated the same way as before for rows that contain or are covered by cells spanning several rows.
CSS Class Moved from Cell to Row -- In general, it was possible to move the CSS class name definitions from the cell to the row HTML elements.
ExpandAll Functionality Improved -- There were cases where several rows with child rows would cause long initialization time when ExpandAll was enabled. This issue has been resolved.
Note: This improvement applies only if you are using WebGrid with the Browser property set to Auto. If the Browser property is set to XML, it will remain slow because the grid needs to go through every row in order to render its children on the client.

Breaking Changes in WebGrid