SharePoint

In order to use Xceed DataGrid for Silverlight in SharePoint 2010, SharePoint 2010 and Silverlight 4 must be installed.

Xceed DataGrid for Silverlight provides a SharePoint web part that can be incorporated into any page and used to display data that is retrieved from a list. In order to add the web part to a page, the solution file for Xceed DataGrid for Silverlight (Xceed.Silverlight.DataGrid.SharePoint.WebPart.v#.#.wsp), which contains the web part, must first be added to the list of available SharePoint solutions in the Solution Gallery/Solutions section of SharePoint (1 and 2 in the image below). Once the solution has been uploaded (3) and the web part activated (4), it is now available for use.

To add the Xceed DataGrid for Silverlight web part to a page, begin by creating a new, or editing an existing, web-part page and in the page, click on the Add a Web Part link (1) in the desired section, and select Xceed DataGrid for Silverlight WebPart from the list of available web parts (2).

Configuring the Web Part

With the page in edit mode, select the Edit Web Part option from the drop-down menu to being configuring the Xceed DataGrid for Silverlight web part.

There are 3 sections in the web part's property grid through which the grid can be configured: Xceed - Data, which contains all the data-related settings, Xceed - Appearance, which contains all the apperance-related settings, and Xceed - Behavior, which contains all the behavior-related settings.

The first section, Xceed - Data, exposes the data-related settings (see Table 1), which include the List Source property, which defines the SharePoint list to which the grid will be bound and from which its data will be retrieved. By default, all columns that are defined in the list will be displayed in the grid. To limit the columns that are displayed, uncheck the Auto-Create Columns setting and define the names of the columns to display, each separated by a semicolon (';'), through the Columns setting. How the data items are grouped and sorted can be defined through the Groups and Sort Criteria settings, respectively.

Table 1: Xceed - Data Settings

Setting	Corresponding Property	Description
Use Data Virtualization	If unchecked, a ListDataSourceProvider will be used rather than a WcfDataServicesDataSourceProvider	On-demand data retrieval (data virtualization) ensures that only records that are visible are requested from the server. If unchecked, all data will be retrieved from the server and the source will be run as local.
List Source	ItemsSource Property	The list (data source) to which the grid is bound.
Auto-Create Columns	AutoCreateColumns Property	Indicates whether columns are automatically created from the fields in the data source to which the grid is bound.
Columns	Columns Property	The columns that are displayed in the grid. Each column name must be separated with a semicolon (';').
Groups	GroupDescriptions Property	The groups that are intially displayed in the grid. Each group (i.e., column name) must be separated with a semicolon (';').
Sort Criteria	SortDescriptions Property	The sort criteria that are initially applied to the grid's data. Each criterie (i.e., column name) must be separated with a semicolon (';').

The Xceed - Appearance section exposes the appearance-related settings (see Table 2), which include various column-width settings, the possibility to specifying which headers are footers are to be displayed, the theme to be applied to the grid and its elements, as well as various other settings.

Table 2: Xceed - Appearance Settings

Setting	Corresponding Property	Description
Column Widths	ColumnWidth Property Column.Width Property	The width of each column. Each value must be separated with a semicolon (';') and will be applied to the columns sequentially.
Minimum Column Width	MinColumnWidth Property	The default minimum column width.
Maximum Column Width	MaxColumnWidth Property	The default maximum column width.
Alternate Row Color	AreAlternateStatesEnabled Property	Indicated whether alternate row styles are applied.
Auto-Align Columns	AutoAlignColumns Property	Indicates whether columns should be automatically aligned according to their data type.
Display Group-By Control	DefaultHeadersFooters Property	Indicates whether the group-by controls is displayed in the headers of the grid.
Display Column-Manager Row	DefaultHeadersFooters Property	Indicates whether the column-manager row is displayed in the headers of the grid.
Display Insertion Row	DefaultHeadersFooters Property	Indicates whether the insertion row is displayed in the headers of the grid.
Display Filter Row	DefaultHeadersFooters Property	Indicates whether the filter row is displayed in the headers of the grid.
Display Notification Control	DefaultHeadersFooters Property	Indicates whether the notification controls is displayed in the footers of the grid.
Theme	Styles and Themes topic	The theme applied to the grid and its elements.

The last section, Xceed - Behavior, exposes the behavior-related settings (see Table 3), which include various settings that define the scope of the end user's interaction with the grid and also defines how group navigtion, selection, and clipboard copying behave.

Table 3: Xceed - Behavior Settings

Setting	Corresponding Property	Description
Allow Column Reorder	AllowColumnReorder Property	Indicates whether columns can be reordered by the end user.
Allow Column Resize	AllowColumnResize Property	Indicates whether columns can be resized by the end user.
Allow Grouping	AllowGroup Property	Indicates whether the data items in the grid can be group through end-user interaction.
Allow Group Collapsing	AllowGroupCollapsing Property	Indicates whether groups can be collapsed through end-user interaction.
Allow Group Navigation	AllowGroupNavigation Property	Indicates whether group-navigation controls are displayed.
Allow Sorting	AllowSort Property	Indicates whether the data items in the grid can be sorted through end-user interaction.
Group-Navigation Modes	GroupNavigationModes Property	Indicates which group-navigation controls are displayed in group headers.
Selection Mode	SelectionMode Property	Indicates how the items in the grid can be selected through end-user interaction.
Clipboard Copy Mode	ClipboardCopyMode Property	Indicates whether end users can copy data to the clipboard and whether the information displayed in the column headers should be included. *This feature will only work if data virtualization is NOT used (i.e., Use Data Virtualization* is unchecked).**