Adding a Checkbox to SPGridView in SharePoint 2007

This example creates a very simple grid that as a checkbox on each row. Allowing you to select multiple rows at a time.

Note: You can do it in Html for simple controls, but if you need to add features such as grouping, you will probably have to build your grid programmatically. (see Oscar Medina's post for tips on how to do that)

1. Register the SharePoint web controls on the aspx page

<%@ Register TagPrefix="SharePoint" 

    Namespace="Microsoft.SharePoint.WebControls" 

    Assembly="Microsoft.SharePoint, 

    Version=11.0.0.0, 

    Culture=neutral, 

    PublicKeyToken=71e9bce111e9429c" %>

 

2. Declare your SPGridView control in the Html with the first column being a TemplateField control holding your checkbox.  You can also add a hidden field to hold the ID of the ListItem.

 

<SharePoint:SPGridView id="grid" allowsorting="true" autogeneratecolumns="false" runat="server">

    <Columns>

        <asp:TemplateField headertext="Select">

            <ItemTemplate>

                <input id="select" type="checkbox" runat="server" />

                <input id="itemID" type="hidden" runat="server" />

            </ItemTemplate>

        </asp:TemplateField>

    </Columns>

</SharePoint:SPGridView>

 

3. If you know the data columns, you can declare them here too. Or you can build them dynamically at step 5 (see my previous post)

4. In your code-behind page, add a reference to your grid

public class MycodeBehind : System.Web.UI.Page 

{

    protected SPGridView grid;

5. Create a method to build the data fields dynamically (see my previous post)

6. Wire up an event handler for the RowDataBound event.

grid.RowDataBound += new GridViewRowEventHandler(grid_RowDataBound);

7. Create your Event Handler method.  This method will set the itemID field value to the ID of the ListItem.  You can use this field on the post back to identify the ListItem.

private void grid_RowDataBound(object sender, GridViewRowEventArgs e)

{ 

    if (e.Row.RowType == DataControlRowType.DataRow)

    {

        HtmlInputHidden itemID = (HtmlInputHidden)e.Row.FindControl("itemID");

        if (itemID != null)

        {

            DataRowView data = (DataRowView)e.Row.DataItem;

            itemID.Value = data["ID"].ToString();

        }

    }

}

 

8. Add this code to the post back event (OnClick most likely).  This will loop through your grid and find all the rows that are checked.  Once you have a checked row, you can use the itemID value to quickly find the corresponding ListItem.

for (int i = 0; i < grid.Rows.Count; i++)

{ 

    HtmlInputCheckBox selectCtl = (HtmlInputCheckBox)grid.Rows[i].FindControl("select");

    HtmlInputHidden itemIDCtl = (HtmlInputHidden)grid.Rows[i].FindControl("itemID");

    if (selectCtl.Checked && itemIDCtl.Value != "")

    { 

        // find the row so we can retrieve the values 

        SPListItem myListItem = myList.Items.GetItemById(Convert.ToInt32(itemIDCtl.Value));

        // do whatever you need to do

    } 

}