Skip to end of metadata
Go to start of metadata

Remarks

UXGridView provides a flexible way to display a collection of data in rows and columns. The built-in column types include a text box column, a check box column, combo box column and template column for hosting custom content. The built-in row type includes a drop-down details section that you can use to display additional content below the cell values.

To bind UXGridView to data, set the ItemsSource property to an object that implements IEnumerable. Each row in the UXGridView is bound to an object in the data source, and each column in the UXGridView is bound to a property of the data object. In order for the UXGridView user interface to update automatically when items are added to or removed from the source data, UXGridView must be bound to a collection that implements INotifyCollectionChanged, such as an ObservableCollection<T>. In addition, for the user interface to automatically reflect property changes, the objects in the source collection must implement the INotifyPropertyChanged interface.

The following code shows a simple UXGridView with data binding in XAML.

XAML

For more information about UXGridView, see UXGridView Overview.

Example

The following code shows a simple UXGridView with data binding in XAML.

XAML

Working with AutoGenerateColumns Property and Columns Property

By default, the UXGridView control generates columns automatically when you set the ItemsSource property. The generated columns are of type UXGridViewCheckBoxColumn for bound Boolean (and nullable Boolean) properties, and of type UXGridViewTextColumn for all other properties. If a property does not have a string or numeric value type, the generated text box columns are read-only and display the data object's ToString value.

You can prevent automatic column generation by setting the AutoGenerateColumns property to false. This is useful when you want to create and configure all columns explicitly. Alternatively, you can let the data grid generate the columns, but handle the AutoGeneratingColumn event to customize columns after they are instantiated. To rearrange the display order of the columns, you can set the DisplayIndex property to the desired value for each individual column.

Generated columns recognize the DisplayAttribute if it is present on the source object. The DisplayAttribute.ShortName property is used to specify column header text. The DisplayAttribute.Order property is used to specify the order in which columns appear. The DisplayAttribute.AutoGenerateField property is used to specify whether the field has a column generated for it.

Regardless of how you generate the columns, you can access the Columns collection to programmatically add, insert, remove, and change any columns in the control at run time. Alternatively, you can specify columns in XAML, in which case you should set AutoGenerateColumns to false. Creating your own columns enables you to use additional column types, such as the UXGridViewCheckBoxColumn, UXGridViewExpanderColumn, UXGridViewSelectColumn, UXGridViewTemplateColumn or other custom column type that inherited from UXGridViewColumn.

The following list describes the built-in column types available in UXGridView.

  • UXGridViewCheckBoxColumn type provides an easy way to enable editing using combo box. You can provide the data for the editing combo box through the provided ValueListSource property, and determine the DisplayMemberPath and ValueMemberPath for the display and value object respectively.

    XAML

  • UXGridViewExpanderColumn type provides an easy way to expand and collapse a row details if you enable row details in UXGridView.

    XAML

  • UXGridViewSelectColumn type provides an easy way to enable selector column which allows you to check or uncheck a row in UXGridView. The checked items are accessible in the CheckedItems property. This column type also automatically adds a checkbox in the column header, allowing users to easily toggle the checked state of all the rows in the view.

    XAML

  • UXGridViewTemplateColumn type provides full flexibility to create custom columns with specific behaviors that meet your application's requirements. The CellTemplate and CellEditingTemplate properties enable you to specify the content templates for both display and editing mode.

    XAML

    TheCellTemplate and CellEditingTemplate properties are also available in all built-in column types, allowing you to change the display and editing template for the desired columns.

Working with CanUserAddRows Property, CanUserDeleteRows Property and CanUserEditRows Property

Data editing in UXGridView involves three fundamental processes, Create, Update and Delete (CUD). You can enable each editing feature by setting the property CanUserAddRowsCanUserEditRows and CanUserDeleteRows respectively.

Example Title

A NewRow element will appear in the top of the UXGridView user interface when you set the CanUserAddRows property to true, such as shown in the following illustration.

In addition, you can also delete and edit the selected item by setting both the CanUserEditRows and CanUserDeleteRows properties to true.

Working with CanUserExport Property

To enable data exporting in UXGridView, you simply set the CanUserExport property of UXGridView to true.

When enabled, an Export dropdown button will appear in the status bar element of UXGridView.

You can also select the format of the exported results from the context menu as shown in the figure above. The supported export format are:

  • HTML
  • Excel
  • CSV
  • Text

Furthermore, you can also customize which element to export through the provided ExportOptions property. The following code shows how to include column footers and group footers in the data export results.

IncludeColumnFooters and IncludeGroupFooters are only applicable for HTML format.

XAML

Working with CanUserGroupColumns Property

XAML

Working with CanUserPage Property

To enable data sorting in UXGridView, you set the CanUserPage property to true and the PageSize property to the number of records per page in UXGridView.

XAML

When enabled, a data pager user interface will appear in the status bar element of UXGridView.

Depending on the QueryOperation property, the data paging can be handled in either client or server side.

Working with CanUserSortColumns Property

To enable data sorting in UXGridView, you set the CanUserSortColumns property of UXGridView to true. If you prefer to enable sorting only on certain columns, set the CanUserSort property of the UXGridColumn to true.

XAML

Depending on the value of the QueryOperation property, the data sorting can be handled in either client or server side.

Working with CellEditingTemplateSelector Property

A rather unique scenario is where the users would like to have different editing control for the same column that depends on the data that currently being edited. This can be achieved elegantly in UXGridView by using CellEditingTemplateSelector. It works similarly to any other template selectors.

The following code shows how to create the editing template selector and used it in UXGridView.

Cell Editing Template Selector
View

Working with ColumnFooterVisibility Property

XAML

Working with DeleteRowCommand Property, InsertRowCommand Property, PrepareNewRowCommand Property, RejectChangesCommand Property, RejectRowCommand Property, SaveChangesCommand Property, UpdateCellCommand Property, UpdateRowCommand Property and ValidateRowCommand Property

To handle the CUD operation, UXGridView provides several command-related properties that you can bind to your ViewModel to execute a method depending on the actions. These command-related properties are listed as follows:

  • PrepareNewRowCommand
    Called when you begin edit at the NewRow element. Used to initialized the NewItem.
  • ValidateRowCommand
    Validate the row before the row is committed.
  • InsertRowCommand
    Called when a new row is committed. You can directly save the changes and/or refresh the UXGridView if necessary.
  • UpdateCellCommand
    Called when the cell is committed.
  • UpdateRowCommand
    Called when an existing row is committed. You can directly save the changes and/or refresh the UXGridView if necessary.
  • DeleteRowCommand
    Called when a row is deleted. You can directly save the changes and / or refresh the UXGridView if necessary.
  • RejectRowCommand
    Called when the changes in the row is cancelled. This command is used to reject the changes in the data entity if required (such as in DevForce).
  • SaveChangesCommand
    Called when the save changes command is executed. You handle this command to save all the pending changes made in the UXGridView.
  • RejectChangesCommand
    Called when the reject changes command is executed. You handle this command to reject all the pending changes made in the UXGridView.

You need to bind these command properties to your ViewModel and handle each of the action. Beside these command, UXGridView also provide HasChanges that you can use to determine whether there are existing changes in the data.

The following code example shows how to define and bind the editing commands from ViewModel to UXGridView.

View Model
View

Working with EditEnterKeyAction Property, EditKeyGesture Property and EnterKeyAction Property

The keyboard gesture is determined by several properties such as EditKeyGesture, EnterKeyAction and EditEnterKeyAction. Each property has specific action that you can customize. The following list details the action of each property.

EditEnterKeyAction:

  • CommitAndMovetoNextRow
    Commit the changes made in the edited row and move to the next row.
  • ExitEdit
    Exit the editing of the selected cell.
  • MoveToNextEditableCell
    Move to next editable cell. (Will move to next row’s cell when it reach the end of the row).

EditKeyGesture:

  • F2
    Directly begin edit on the currently selected cell using F2 key.
  • AnyKeystroke
    Directly begin edit on the currently selected cell from any key stroke.

EnterKeyAction:

  • EnterEdit
    Directly begin edit on the selected cell using Enter key.
  • MoveToNextRow
    Move to next row (does not edit the cell).

Working with EditMouseGesture Property

The mouse gesture is determined by the EditMouseGesture property. The following options are available to customize the edit mouse gesture.

  • SingleClick
    Directly begin edit on the selected cell.
  • SecondClick
    Begin edit on the selected cell after the row is selected.
  • DoubleClick
    Directly begin edit on the selected cell when double click fires.

Working with EmptyRowsVisibility Property and NewRowPosition Property

The rows of UXGridView are determined by the number of items specified in items source. If the number of items in items source is less than the available screen estate it will show blank white space.

Setting the EmptyRowsVisibility to Visible enables UXGridView to show empty rows in this blank white space area, to give a better look and feel.

When CanUserAddRows is enabled and EmptyRowsVisibility is set to Visible, you can change the new row position to bottom through NewRowPosition property.

Note that some features are not compatible when CanUserAddRows is enabled and EmptyRowsVisibility is set to Visible such as paging and grouping.

The following are several ways to enter edit mode when the new row position is set to Bottom:

  • Press down key on last row.
  • Press tab key on last column of the last row.
  • Double click on any empty rows when EnterNewRowOnClick is set to False.
  • Click on any on any empty rows when EnterNewRowOnClick is set to True.

Working with ExpandedItem Property

When you expand the row details using any of the methods described above, the ExpandedItem property will be set to the data context of the expanded row. You can use this property for more advanced user interaction, such as displaying a hierarchical grid view.

The following code shows how to create hierarchical grid view using row details.

XAML

The above code shows how to define the row details to create hierarchical grid view and bind the ExpandedItem property to the ViewModel. In the ViewModel, you write a custom logic to load the child data whenever the ExpandedItem property is set.

CS

Working with ExportCommand Property and ExportItems Property

By default, the exporting processes only the data available in the client. Therefore if you enable server paging, you might not be able to export the complete data correctly. To address this challenge, you can implement the ExportCommand in the ViewModel and provide the desired data to the ExportItems property.

The following code shows you how to bind ExportItems and ExportCommand in the ViewModel and supply the data to export.

View Model
View

Working with FrozenColumnCount Property

XAML

Working with GroupByBoxVisibility Property

Alternatively, you can also drag the header of a column to the group box. The group box's visibility can also be toggled from the column's context menu. It can be displayed initially by setting the GroupByBoxVisibility to Visible.

Working with GroupDescriptors Property

XAML

Working with GroupFootersVisibility Property

XAML
You can also set multiple values on the Aggregate property such as shown in the following example.
XAML

Working with IsReadOnlyBinding Property

The following code shows how to implement the IsReadOnlyBinding to achieve the above scenario.

XAML

Working with ScrollIndicatorBinding Property

The following code shows how to use the ScrollIndicatorBinding to customize the data display in the scroll indicator element.

XAML

Working with SelectedItem Property, SelectedItems Property, SelectionMode Property and SelectionUnit Property

UXGridView has three type of SelectionMode that you can choose from.

  • Single
    Only one item can be selected.
  • Multiple
    Allow multiple item to be selected.
  • Extended
    Allow multiple item to be selected. You need to hold Shift and / or Ctrl modifier to perform the multiple selection.

When a row is selected, the SelectedItem and SelectedItems property will be automatically synchronized. You can bind these properties to your ViewModel to capture the currently selected items.

Furthermore, you can also customize the SelectionUnit to one of the possible three values: Row, Cell or RowAndCell.

Working with SortDescriptions Property

The following example shows how to implement predefined sorting with client data operation.

XAML

Definition

public class UXGridView : ISControl

Summary

The following table summarizes the members exposed in this class.

Public Constructors

UXGridView Constructor()Initializes a new instance of UXGridView class.

Public Properties

AlternatingRowBackgroundGets or sets the Brush that is used to paint the background of odd-numbered rows.
AreRowDetailsFrozenGets or sets a value that indicates whether the row details sections remain fixed at the width of the display area or can scroll horizontally.
AreRowGroupHeadersFrozenGets or sets a value that indicates whether the row group header sections remain fixed at the width of the display area or can scroll horizontally.
AutoEditOperationGets or sets a value that indicates whether UXGridView should try perform IEditableCollectionView.CommitEdit or IEditableObject.EndEdit after each data editing operation.
AutoFocusOnErrorGets or sets a value that indicates whether UXGridView should auto focus on cell when there is validation error.
AutoGenerateColumnsGets or sets a value that indicates whether columns are created automatically when the ItemsSource property is set.
BusyLatencyGets or sets the latency, in seconds, before the busy indicator is displayed when IsBusy is set to true.
BusyOverlayBackgroundGets or sets the brush to apply to the overlay background.
CanUserAddRowsGets or sets a value that indicates whether the user can add new rows.
CanUserBatchUpdateGets or sets a value that indicates whether the UXGridView can perform batch update.
CanUserDeleteRowsGets or sets a value that indicates whether the user can delete rows.
CanUserEditRowsGets or sets a value that indicates whether the user can edit rows.
CanUserExportGets or sets a value that indicates whether the user can export data.
CanUserFilterColumnsGets or sets a value that indicates whether the user can filter data based on columns.
CanUserGroupColumnsGets or sets a value that indicates whether the user can group columns
CanUserPageGets or sets a value that indicates whether the user can paging the data.
CanUserReorderColumnsGets or sets a value that indicates whether the user can change the column display order by dragging column headers with the mouse.
CanUserResizeColumnsGets or sets a value that indicates whether the user can adjust column widths using the mouse.
CanUserSortColumnsGets or sets a value that indicates whether the user can sort columns by clicking the column header.
CellBusyTemplateGets or sets the template selector that is used to display the busy indicator for cell.
CellEditingTemplateSelectorGets or sets the template selector that is used to display the contents of a cell that is in editing mode.
CellStyleGets or sets the style that is used when rendering the gridview cells.
CellStyleSelectorGets or sets the style selector that is used when rendering the gridview cells.
CellTemplateSelectorGets or sets the template selector that is used when rendering the gridview cells.
CheckedItemsGets or sets the checked items.
ClipboardCopyModeGets or sets a value that indicates how data is copied to the clipboard.
ColumnFooterCellStyleGets or sets the style that is used when rendering the gridview column footer cell.
ColumnFooterCellStyleSelectorGets or sets the style selector that is used when rendering the gridview column footer cell.
ColumnFooterStyleGets or sets the style that is used when rendering the gridview column footer.
ColumnFooterVisibilityGets or sets a value that determines whether the column footer is visible.
ColumnHeaderHeightGets or sets the height of the column headers row.
ColumnHeaderStyleGets or sets the style that is used when rendering the column headers.
ColumnHeaderStyleSelectorGets or sets the style selector that is used when rendering the column headers.
ColumnHeaderTemplateSelectorGets or sets the template selector that is used when rendering the column headers.
ColumnHeaderVisibilityGets or sets a value that determines whether the column header is visible.
ColumnsGets a collection that contains all the columns in the control.
ColumnWidthGets or sets the standard width or automatic sizing mode of columns in the control.
ContextMenuStyleGets or sets the style that is used when rendering the context menu element.
CornerRadiusRepresents the radius of a border's corner. The radius can't be negative.
CurrentColumnGets or sets the column that contains the current cell.
DeleteRowCommandGets or sets command that will be invoked when deleting a row.
DoubleClickCommandGets or sets the command that will be invoked when validating a row.
DragIndicatorStyleGets or sets the style that is used when rendering the drag indicator that is displayed while dragging column headers.
DropLocationIndicatorStyleGets or sets the style that is used when rendering the column headers.
EditEnterKeyActionGets or sets a value that determines the action when enter key is pressed during editing mode.
EditKeyGestureGets or sets a value that determines the key gesture used to enter the editing mode.
EditMouseGestureGets or sets a value that determines the mouse gesture used to enter the editing mode.
EmptyRowsVisibilityGets or sets a value that determines the visibility of empty rows.
EnableContextMenuGets or sets a value that determines whether context menus is enabled.
EnableRowVirtualizationGets or sets a value that determines whether row virtualization is enabled.
EnterKeyActionGets or sets a value that determines the action when enter key is pressed.
EnterNewRowOnClickGets or sets the a value that determine whether UXGridView will enter edit on new empty row on single click.
ErrorStatusVisibilityGets or sets a value that determines whether the error status is visible.
ExpandedItemGets or sets the expanded item.
ExportCommandGets or sets command that will be invoked when exporting data.
ExportCssStyleSelectorGets or sets the css style selector using for HTML exporting.
ExportItemsGets or sets the items to be exported.
ExportOptionsGets or sets the export options.
FilterDescriptorsGets or sets the descriptor object that encapsulates the filtering related information.
FrozenColumnCountGets or sets the number of columns that the user cannot scroll horizontally.
GridLinesVisibilityGets or sets a value that indicates which grid lines separating inner cells are shown.
GroupByBoxStyleGets or sets the style that is used when rendering the group by box element.
GroupByBoxVisibilityGets or sets a value that determines whether the group by box is visible.
GroupDescriptorsGets collection of group descriptors.
GroupFootersVisibilityGets or sets a value that determines whether the group footer is visible.
HasChangesGets or sets a value that indicates whether there are data changes or not.
HeaderAndRowSeparatorBrushGets or sets the Brush that is used to paint lines separating rows and column header.
HorizontalGridLinesBrushGets or sets the Brush that is used to paint grid lines separating rows.
HorizontalScrollBarVisibilityGets or sets a value that indicates how the horizontal scroll bar is displayed.
HorizontalScrollModeGets or sets a value that determine the horizontal scroll mode.
InsertRowCommandGets or sets command that will be invoked when inserting row.
IsBusyGets or sets a value that indicates whether the control is busy.
IsInsertingNewRowGets or sets a value that indicates whether the UXGridView new row is activated.
IsReadOnlyBindingGets or sets the binding that associates the IsReadOnly attribute with a property in the data source.
IsRefreshedGets or sets a value that indicates whether the UXGridView is refreshed.
IsRowDirtyBindingGets or sets the binding that associates the IsReadOnly attribute with a property in the data source.
IsValidGets a value that indicates whether data in the grid is valid.
ItemsSourceGets or sets a collection that is used to generate the content of the control.
LostFocusActionGets or sets a value that determine the lost focus action when user lost focus during row editing.
MaxColumnWidthGets or sets the maximum width of columns in the UXGridView.
MinColumnWidthGets or sets the minimum width of columns in the UXGridView.
NewItemGets or sets the new item to be added.
NewRowLostFocusActionGets or sets a value that determine the lost focus action when user lost focus during new row editing.
NewRowPositionGets or sets a value that determine the position of new row.
NoDataTemplateGets or sets the no data template.
PageDescriptorGets or sets the descriptor object that encapsulates the paging related information.
PagerAutoEllipsisGets or sets a value that indicates whether to use an ellipsis as the last numeric button of UXDataPager.
PagerDisplayModeGets or sets a value that indicates how the UXDataPager user interface is displayed.
PagerNumericButtonCountGets or sets a value that indicates the number of page buttons shown on the UXDataPager user interface.
PagerStyleGets or sets the style that is used when rendering the UXDataPager.
PageSizeGets or sets a value that indicates the number of items displayed on a page.
PrepareNewRowCommandGets or sets command that will be invoked when preparing new row.
QueryOperationGets or sets a value that determines whether the filtering operation should be performed in client-side or server-side.
RefreshCommandGets or sets command that will be invoked when refreshing data.
RefreshCommandParameterGets or sets the parameter to pass to the RefreshCommand property.
RejectChangesCommandGets or sets command that will be invoked when data changes is rejected.
RejectRowCommandGets or sets command that will be invoked when row changes is rejected.
ResourceOverrideGets or sets the individual resource object to override the existing localized resource.
RowBackgroundGets or sets the Brush that is used to paint row backgrounds.
RowDetailsTemplateGets or sets the template that is used to display the content of the details section of rows.
RowDetailsTemplateSelectorGets or sets the template selector that is used to display the content of the details section of rows.
RowDetailsVisibilityModeGets or sets a value that indicates when the details sections of rows are displayed.
RowGroupFooterCellStyleGets or sets the style that is used when rendering the row group footer cell.
RowGroupFooterCellStyleSelectorGets or sets the style selector that is used when rendering the row group footer cell.
RowGroupFooterStyleGets or sets the style that is used when rendering the row group footer.
RowGroupFooterStyleSelectorGets or sets the style selector that is used when rendering the row group footer.
RowGroupHeaderStyleGets or sets the style that is used when rendering the row group header.
RowGroupHeaderStyleSelectorGets or sets the style selector that is used when rendering the row group header.
RowGroupHeaderTemplateSelectorGets or sets the template selector that is used when rendering the row group headers.
RowHeaderStyleGets or sets the style that is used when rendering the row header.
RowHeaderVisibilityGets or sets a value that determines whether the row header is visible.
RowHeaderWidthGets or sets the width of the row header column.
RowHeightGets or sets the standard height of rows in the control.
RowStyleGets or sets the style that is used when rendering the rows.
RowStyleSelectorGets or sets the style selector that is used when rendering the rows.
RowTemplateGets or sets the template that is used when rendering the rows.
RowTemplateSelectorGets or sets the template selector that is used when rendering the rows.
SaveChangesCommandGets or sets command that will be invoked when data changes is accepted.
ScrollBarStyleGets or sets the style that is used when rendering the scrollbar.
ScrollCornerBackgroundGets or sets the Brush that is used to paint scroll corner element.
ScrollIndicatorBindingGets or sets the binding that associates the scroll indicator with property in the data source.
ScrollIndicatorStyleGets or sets the style that is used when rendering the scroll indicator.
ScrollIndicatorTemplateGets or sets the template that is used when rendering the scroll indicator.
SelectedIndexGets or sets the index of the current selection.
SelectedItemGets or sets the data item corresponding to the selected row.
SelectedItemsGets a list that contains the data items corresponding to the selected rows.
SelectionModeGets or sets the selection behavior of the gridview.
SelectionUnitGets or sets the selection unit of gridview.
SortDescriptionsGets or sets the sort descriptions object that encapsulates the sorting related information.
SortDescriptorsGets or sets the descriptor object that encapsulates the sorting related information.
StatusBarCommandTemplateGets or sets the data template to apply to the StatusBarCommand.
StatusBarStyleGets or sets the style that is used when rendering the statusbar.
StatusBarVisibilityGets or sets a value that determines whether the status bar is visible.
UpdateCellCommandGets or sets command that will be invoked when updating a cell.
UpdateRowCommandGets or sets command that will be invoked when updating a row.
ValidateRowCommandGets or sets the command that will be invoked when validating a row.
ValidationResultsGets or sets the validation results.
VerticalGridLinesBrushGets or sets the Brush that is used to paint grid lines separating columns.
VerticalScrollBarVisibilityGets or sets a value that indicates how the vertical scroll bar is displayed.
VerticalScrollModeGets or sets a value that indicates the vertical scroll mode.

Protected Properties

CurrentItemGets the data item bound to the row that contains the current cell.
ProductProduct Info.

Fields

AlternatingRowBackgroundPropertyIdentifies the AlternatingRowBackground dependency property.
AreRowDetailsFrozenPropertyIdentifies the AreRowDetailsFrozen dependency property.
AreRowGroupHeadersFrozenPropertyIdentifies the AreRowGroupHeadersFrozen dependency property.
AutoEditOperationPropertyIdentifies the AutoEditOperation dependency property.
AutoFocusOnErrorPropertyIdentifies the AutoFocusOnError dependency property.
AutoGenerateColumnsPropertyIdentifies the AutoGenerateColumns dependency property.
BusyLatencyPropertyIdentifies the BusyLatency dependency property.
BusyOverlayBackgroundPropertyIdentifies the BusyOverlayBackground dependency property.
CanUserAddRowsPropertyIdentifies the CanUserAddRows dependency property.
CanUserBatchUpdatePropertyIdentifies the CanUserBatchUpdate dependency property.
CanUserDeleteRowsPropertyIdentifies the CanUserDeleteRows dependency property.
CanUserEditRowsPropertyIdentifies the CanUserEditRows dependency property.
CanUserExportPropertyIdentifies the CanUserExport dependency property.
CanUserFilterColumnsPropertyIdentifies the CanUserFilterColumns dependency property.
CanUserGroupColumnsPropertyIdentifies the CanUserGroupColumns dependency property.
CanUserPagePropertyIdentifies the CanUserPage dependency property.
CanUserReorderColumnsPropertyIdentifies the CanUserReorderColumns dependency property.
CanUserResizeColumnsPropertyIdentifies the CanUserResizeColumns dependency property.
CanUserSortColumnsPropertyIdentifies the CanUserSortColumns dependency property.
CellBusyTemplatePropertyIdentifies the CellBusyTemplate dependency property.
CellEditingTemplateSelectorPropertyIdentifies the CellEditingTemplateSelector dependency property.
CellStylePropertyIdentifies the CellStyle dependency property.
CellStyleSelectorPropertyIdentifies the CellStyleSelector dependency property.
CellTemplateSelectorPropertyIdentifies the CellTemplateSelector dependency property.
CheckedItemsPropertyIdentifies the CheckedItems dependency property.
ClipboardCopyModePropertyIdentifies the ClipboardCopyMode dependency property.
ColumnFooterCellStylePropertyIdentifies the ColumnFooterCellStyle dependency property.
ColumnFooterCellStyleSelectorPropertyIdentifies the ColumnFooterCellStyleSelector dependency property.
ColumnFooterStylePropertyIdentifies the ColumnFooterStyle dependency property.
ColumnFooterVisibilityPropertyIdentifies the ColumnFooterVisibility dependency property.
ColumnHeaderHeightPropertyIdentifies the ColumnHeaderHeight dependency property.
ColumnHeaderStylePropertyIdentifies the ColumnHeaderStyle dependency property.
ColumnHeaderStyleSelectorPropertyIdentifies the ColumnHeaderStyleSelector dependency property.
ColumnHeaderTemplateSelectorPropertyIdentifies the ColumnHeaderTemplateSelector dependency property.
ColumnHeaderVisibilityPropertyIdentifies the ColumnHeaderVisibility dependency property.
ColumnsPropertyIdentifies the Columns dependency property.
ColumnWidthPropertyIdentifies the ColumnWidth dependency property.
ContextMenuStylePropertyIdentifies the ContextMenuStyle dependency property.
CornerRadiusPropertyIdentifies the CornerRadius dependency property.
DeleteRowCommandPropertyIdentifies the DeleteRowCommand dependency property.
DoubleClickCommandPropertyIdentifies the DoubleClickCommand dependency property.
DragIndicatorStylePropertyIdentifies the DragIndicatorStyle dependency property.
DropLocationIndicatorStylePropertyIdentifies the DropLocationIndicatorStyle dependency property.
EditEnterKeyActionPropertyIdentifies the EditEnterKeyAction dependency property.
EditKeyGesturePropertyIdentifies the EditKeyGesture dependency property.
EditMouseGesturePropertyIdentifies the EditMouseGesture dependency property.
EmptyRowsVisibilityPropertyIdentifies the EmptyRowsVisibility dependency property.
EnableContextMenuPropertyIdentifies the EnableContextMenu dependency property.
EnableRowVirtualizationPropertyIdentifies the EnableRowVirtualization dependency property.
EnterKeyActionPropertyIdentifies the EnterKeyAction dependency property.
EnterNewRowOnClickPropertyIdentifies the EnterNewRowOnClick dependency property.
ErrorStatusVisibilityPropertyIdentifies the ErrorStatusVisibility dependency property.
ExpandedItemPropertyIdentifies the ExpandedItem dependency property.
ExportCommandPropertyIdentifies the ExportCommand dependency property.
ExportCssStyleSelectorPropertyIdentifies the ExportCssStyleSelector dependency property.
ExportItemsPropertyIdentifies the ExportItems dependency property.
ExportOptionsPropertyIdentifies the ExportOptions dependency property.
FilterDescriptorsPropertyIdentifies the FilterDescriptors dependency property.
FrozenColumnCountPropertyIdentifies the FrozenColumnCount dependency property.
GridLinesVisibilityPropertyIdentifies the GridLinesVisibility dependency property.
GroupByBoxStylePropertyIdentifies the GroupByBoxStyle dependency property.
GroupByBoxVisibilityPropertyIdentifies the GroupByBoxVisibility dependency property.
GroupFootersVisibilityPropertyIdentifies the GroupFootersVisibility dependency property.
HasChangesPropertyIdentifies the HasChanges dependency property.
HeaderAndRowSeparatorBrushPropertyIdentifies the HeaderAndRowSeparatorBrush dependency property.
HorizontalGridLinesBrushPropertyIdentifies the HorizontalGridLinesBrush dependency property.
HorizontalScrollBarVisibilityPropertyIdentifies the HorizontalScrollBarVisibility dependency property.
HorizontalScrollModePropertyIdentifies the HorizontalScrollMode dependency property.
InsertRowCommandPropertyIdentifies the InsertRowCommand dependency property.
IsBusyPropertyIdentifies the IsBusy dependency property.
IsInsertingNewRowPropertyIdentifies the IsInsertingNewRow dependency property.
IsRefreshedPropertyIdentifies the IsRefreshed dependency property.
IsValidPropertyIdentifies the IsValid dependency property.
ItemsSourcePropertyIdentifies the ItemsSource dependency property.
LostFocusActionPropertyIdentifies the LostFocusAction dependency property.
MaxColumnWidthPropertyIdentifies the MaxColumnWidth dependency property.
MinColumnWidthPropertyIdentifies the MinColumnWidth dependency property.
NewItemPropertyIdentifies the NewItem dependency property.
NewRowLostFocusActionPropertyIdentifies the NewRowLostFocusAction dependency property.
NewRowPositionPropertyIdentifies the NewRowPosition dependency property.
NoDataTemplatePropertyIdentifies the NoDataTemplate dependency property.
PageDescriptorPropertyIdentifies the QueryDescriptor dependency property.
PagerAutoEllipsisPropertyIdentifies the PagerAutoEllipsis dependency property.
PagerDisplayModePropertyIdentifies the PagerDisplayMode dependency property.
PagerNumericButtonCountPropertyIdentifies the PagerNumericButtonCount dependency property.
PagerStylePropertyIdentifies the PagerStyle dependency property.
PageSizePropertyIdentifies the PageSize dependency property.
PrepareNewRowCommandPropertyIdentifies the PrepareNewRowCommand dependency property.
QueryOperationPropertyIdentifies the QueryOperation dependency property.
RefreshCommandParameterPropertyIdentifies the RefreshCommandParameter dependency property.
RefreshCommandPropertyIdentifies the RefreshCommand dependency property.
RejectChangesCommandPropertyIdentifies the RejectChangesCommand dependency property.
RejectRowCommandPropertyIdentifies the RejectRowCommand dependency property.
ResourceOverridePropertyIdentifies the ResourceOverride dependency property.
RowBackgroundPropertyIdentifies the RowBackground dependency property.
RowDetailsTemplatePropertyIdentifies the RowDetailsTemplate dependency property.
RowDetailsTemplateSelectorPropertyIdentifies the RowDetailsTemplateSelector dependency property.
RowDetailsVisibilityModePropertyIdentifies the RowDetailsVisibilityMode dependency property.
RowGroupFooterCellStylePropertyIdentifies the RowGroupFooterCellStyle dependency property.
RowGroupFooterCellStyleSelectorPropertyIdentifies the RowGroupFooterCellStyleSelector dependency property.
RowGroupFooterStylePropertyIdentifies the RowGroupFooterStyle dependency property.
RowGroupFooterStyleSelectorPropertyIdentifies the RowGroupFooterStyleSelector dependency property.
RowGroupHeaderStylePropertyIdentifies the RowGroupHeaderStyle dependency property.
RowGroupHeaderStyleSelectorPropertyIdentifies the RowGroupHeaderStyleSelector dependency property.
RowGroupHeaderTemplateSelectorPropertyIdentifies the RowGroupHeaderTemplateSelector dependency property.
RowHeaderStylePropertyIdentifies the RowHeaderStyle dependency property.
RowHeaderVisibilityPropertyIdentifies the RowHeaderVisibility dependency property.
RowHeaderWidthPropertyIdentifies the RowHeaderWidth dependency property.
RowHeightPropertyIdentifies the RowHeight dependency property.
RowStylePropertyIdentifies the RowStyle dependency property.
RowStyleSelectorPropertyIdentifies the RowStyleSelector dependency property.
RowTemplatePropertyIdentifies the RowTemplate dependency property.
RowTemplateSelectorPropertyIdentifies the RowTemplateSelector dependency property.
SaveChangesCommandPropertyIdentifies the SaveChangesCommand dependency property.
ScrollBarStylePropertyIdentifies the ScrollBarStyle dependency property.
ScrollCornerBackgroundPropertyIdentifies the ScrollCornerBackground dependency property.
ScrollIndicatorStylePropertyIdentifies the ScrollIndicatorStyle dependency property.
ScrollIndicatorTemplatePropertyIdentifies the ScrollIndicatorTemplate dependency property.
SelectedIndexPropertyIdentifies the SelectedIndex dependency property.
SelectedItemPropertyIdentifies the SelectedItem dependency property.
SelectedItemsPropertyIdentifies the SelectedItems dependency property.
SelectionModePropertyIdentifies the SelectionMode dependency property.
SelectionUnitPropertyIdentifies the SelectionUnit dependency property.
SortDescriptorsPropertyIdentifies the SortDescriptors dependency property.
StatusBarCommandTemplatePropertyIdentifies the StatusBarCommandTemplate dependency property.
StatusBarStylePropertyIdentifies the StatusBarStyle dependency property.
StatusBarVisibilityPropertyIdentifies the StatusBarVisibility dependency property.
UpdateCellCommandPropertyIdentifies the UpdateCellCommand dependency property.
UpdateRowCommandPropertyIdentifies the UpdateRowCommand dependency property.
ValidateRowCommandPropertyIdentifies the ValidateRowCommand dependency property.
ValidationResultsPropertyIdentifies the ValidationResults dependency property.
VerticalGridLinesBrushPropertyIdentifies the VerticalGridLinesBrush dependency property.
VerticalScrollBarVisibilityPropertyIdentifies the VerticalScrollBarVisibility dependency property.
VerticalScrollModePropertyIdentifies the VerticalScrollMode dependency property.

Public Methods

AttachEventHandlers()Attach built-in event handlers to control templates. Call this method if necessary.
BeginEdit()Causes the gridview to enter editing mode for the current cell and current row, unless the gridview is already in editing mode.
BeginEdit(RoutedEventArgs)Causes the gridview to enter editing mode for the current cell and current row in the specified keyboard and mouse state.
CancelEdit()Causes the gridview to cancel the current edit, restore the original value, and exit editing mode.
CancelEdit(EditingUnit)Causes the gridview to cancel the current edit, restore the original value, and exit editing mode.
CollapseRowGroup(CollectionViewGroup, bool)Collapses gridview row groups.
CommitEdit()Causes the gridview to commit the current edit to the data source and exit editing mode.
CommitEdit(EditingUnit, bool)Causes the gridview to commit the current edit to the data source, and optionally exit editing mode.
DetachedEventHandlers()Detach built-in event handlers from control templates. Call this method if necessary.
Dispose()Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
ExpandRowGroup(CollectionViewGroup, bool)Expands gridview row groups.
Export(Stream, UXGridViewExportOptions)Export data to the specified stream.
InitializeTemplates()Initializes control templates.
OnApplyTemplate()Builds the visual tree for the UXGridView when a new template is applied.
ScrollIntoView(object, UXGridViewColumn)Scrolls the UXGridView vertically to display the row for the specified data item and scrolls the UXGridView horizontally to display the specified column.

Protected Methods

ArrangeOverride(Size)Provides the behavior for the Arrange pass of Silverlight layout.
MeasureOverride(Size)Provides the behavior for the Measure pass of Silverlight layout.
OnAutoGeneratingColumn(UXGridViewAutoGeneratingColumnEventArgs)Raises the AutoGeneratingColumn event.
OnBeginningEdit(UXGridViewBeginningEditEventArgs)Raises the BeginningEdit event.
OnCellEditEnded(UXGridViewCellEditEndedEventArgs)Raises the CellEditEnded event.
OnCellEditEnding(UXGridViewCellEditEndingEventArgs)Raises the CellEditEnding event.
OnColumnDisplayIndexChanged(UXGridViewColumnEventArgs)Raises the ColumnDisplayIndexChanged event.
OnCopyingRowClipboardContent(UXGridViewRowClipboardEventArgs)Raises the CopyingRowClipboardContent event.
OnCurrentCellChanged(ISRoutedEventArgs)Raises the CurrentCellChanged event.
OnGotFocus(RoutedEventArgs)Called before the GotFocus event occurs.
OnLoadingRow(UXGridViewRowEventArgs)Raises the LoadingRow event.
OnLoadingRowDetails(UXGridViewRowDetailsEventArgs)Raises the LoadingRowDetails event.
OnLoadingRowGroup(UXGridViewRowGroupHeaderEventArgs)Raises the LoadingRowGroup event.
OnLostFocus(RoutedEventArgs)Called before the LostFocus event occurs.
OnMouseWheel(MouseWheelEventArgs)Called before the MouseWheel event occurs.
OnPreparingCellForEdit(UXGridViewPreparingCellForEditEventArgs)Raises the PreparingCellForEdit event.
OnRowEditEnded(UXGridViewRowEditEndedEventArgs)Raises the RowEditEnded event.
OnRowEditEnding(UXGridViewRowEditEndingEventArgs)Raises the RowEditEnding event.
OnSelectionChanged(UXGridViewSelectionChangedEventArgs)Raises the SelectionChanged event.
OnUnloadingRow(UXGridViewRowEventArgs)Raises the UnloadingRow event.
OnUnloadingRowDetails(UXGridViewRowDetailsEventArgs)Raises the UnloadingRowDetails event.
OnUnloadingRowGroup(UXGridViewRowGroupHeaderEventArgs)Raises the UnloadingRowGroup event.

Events

AutoGeneratingColumnOccurs one time for each public, non-static property in the bound data type when the ItemsSource property is changed and the AutoGenerateColumns property is true.
BeginningEditOccurs before a cell or row enters editing mode.
CellEditEndedOccurs when a cell edit has been committed or canceled.
CellEditEndingOccurs when a cell edit is ending.
ColumnDisplayIndexChangedOccurs when the DisplayIndex property of a column changes.
ColumnReorderedOccurs when a UXGridView column has moved to a new position in the display order.
ColumnReorderingOccurs before a UXGridView column moves to a new position in the display order.
CopyingRowClipboardContentOccurs when the row is prepared for a clipboard copy operation.
CurrentCellChangedOccurs when a different cell becomes the current cell.
ExportedOccurs when data is succesfully exported.
ExportingOccurs when data is being exported.
PreparingCellForEditOccurs when a cell in a column enters editing mode.
RowDetailsVisibilityChangedOccurs when the RowDetailsVisibilityMode property value changes.
RowEditEndedOccurs when a row edit has been committed or canceled.
RowEditEndingOccurs when a row edit is ending.
SelectionChangedOccurs when the SelectedItem or SelectedItems property value changes.

Public Constructors

public UXGridView()

Initializes a new instance of UXGridView class.

Public Properties

public Brush AlternatingRowBackground { get; set; }

Gets or sets the Brush that is used to paint the background of odd-numbered rows.

public bool AreRowDetailsFrozen { get; set; }

Gets or sets a value that indicates whether the row details sections remain fixed at the width of the display area or can scroll horizontally.

public bool AreRowGroupHeadersFrozen { get; set; }

Gets or sets a value that indicates whether the row group header sections remain fixed at the width of the display area or can scroll horizontally.

public bool AutoEditOperation { get; set; }

Gets or sets a value that indicates whether UXGridView should try perform IEditableCollectionView.CommitEdit or IEditableObject.EndEdit after each data editing operation.

public bool AutoFocusOnError { get; set; }

Gets or sets a value that indicates whether UXGridView should auto focus on cell when there is validation error.

public bool AutoGenerateColumns { get; set; }

Gets or sets a value that indicates whether columns are created automatically when the ItemsSource property is set.

public double BusyLatency { get; set; }

Gets or sets the latency, in seconds, before the busy indicator is displayed when IsBusy is set to true.

public Brush BusyOverlayBackground { get; set; }

Gets or sets the brush to apply to the overlay background.

public bool CanUserAddRows { get; set; }

Gets or sets a value that indicates whether the user can add new rows.

public bool CanUserBatchUpdate { get; set; }

Gets or sets a value that indicates whether the UXGridView can perform batch update.

public bool CanUserDeleteRows { get; set; }

Gets or sets a value that indicates whether the user can delete rows.

public bool CanUserEditRows { get; set; }

Gets or sets a value that indicates whether the user can edit rows.

public bool CanUserExport { get; set; }

Gets or sets a value that indicates whether the user can export data.

public bool CanUserFilterColumns { get; set; }

Gets or sets a value that indicates whether the user can filter data based on columns.

Remarks

UXGridView provides built-in column filtering which comes with rich user interface, allowing users to quickly perform data filtering. To enable data filtering in UXGridView, you simply set the CanUserFilterColumns property to true at UXGridView level, or UXGridViewColumn property at column level to enable the feature only in certain columns. For the column filtering to work properly, you also need to specify the UXGridViewBoundColumn, FilterMemberPath and FilterValuePath properties to each column that supports data filtering.

 

public bool CanUserGroupColumns { get; set; }

Gets or sets a value that indicates whether the user can group columns

Remarks

To enable data grouping in UXGridView, you set the CanUserGroupColumns property of UXGridView to true. Alternatively, you can set the UXGridViewColumn property of UXGridViewColumn to enable the grouping feature only in certain columns.

 

public bool CanUserPage { get; set; }

Gets or sets a value that indicates whether the user can paging the data.

public bool CanUserReorderColumns { get; set; }

Gets or sets a value that indicates whether the user can change the column display order by dragging column headers with the mouse.

public bool CanUserResizeColumns { get; set; }

Gets or sets a value that indicates whether the user can adjust column widths using the mouse.

public bool CanUserSortColumns { get; set; }

Gets or sets a value that indicates whether the user can sort columns by clicking the column header.

public DataTemplate CellBusyTemplate { get; set; }

Gets or sets the template selector that is used to display the busy indicator for cell.

public DataTemplateSelector CellEditingTemplateSelector { get; set; }

Gets or sets the template selector that is used to display the contents of a cell that is in editing mode.

Remarks

A rather unique scenario is where the users would like to have different editing control for the same column that depends on the data that currently being edited. This can be achieved elegantly in UXGridView by using CellEditingTemplateSelector. It works similarly to any other template selectors.

 

public Style CellStyle { get; set; }

Gets or sets the style that is used when rendering the gridview cells.

public StyleSelector CellStyleSelector { get; set; }

Gets or sets the style selector that is used when rendering the gridview cells.

public DataTemplateSelector CellTemplateSelector { get; set; }

Gets or sets the template selector that is used when rendering the gridview cells.

public IEnumerable CheckedItems { get; set; }

Gets or sets the checked items.

Remarks

UXGridViewSelectColumn type provides an easy way to enable selector column which allows you to check or uncheck a row in UXGridView. The checked items are accessible in the CheckedItems property. This column type also automatically adds a checkbox in the column header, allowing users to easily toggle the checked state of all the rows in the view.

 

public ClipboardCopyMode ClipboardCopyMode { get; set; }

Gets or sets a value that indicates how data is copied to the clipboard.

public Style ColumnFooterCellStyle { get; set; }

Gets or sets the style that is used when rendering the gridview column footer cell.

public StyleSelector ColumnFooterCellStyleSelector { get; set; }

Gets or sets the style selector that is used when rendering the gridview column footer cell.

public Style ColumnFooterStyle { get; set; }

Gets or sets the style that is used when rendering the gridview column footer.

public Visibility ColumnFooterVisibility { get; set; }

Gets or sets a value that determines whether the column footer is visible.

Remarks

To display aggregate values of a UXGridViewBoundColumn, you set the ColumnFooterVisibility property to Visible and specify the UXGridViewBoundColumn property to the desired aggregate mode. You can also specify a string format to the aggregate value through the provided UXGridViewBoundColumn property.

 

public double ColumnHeaderHeight { get; set; }

Gets or sets the height of the column headers row.

public Style ColumnHeaderStyle { get; set; }

Gets or sets the style that is used when rendering the column headers.

public StyleSelector ColumnHeaderStyleSelector { get; set; }

Gets or sets the style selector that is used when rendering the column headers.

public DataTemplateSelector ColumnHeaderTemplateSelector { get; set; }

Gets or sets the template selector that is used when rendering the column headers.

public Visibility ColumnHeaderVisibility { get; set; }

Gets or sets a value that determines whether the column header is visible.

public ObservableCollection<UXGridViewColumn> Columns { get; set; }

Gets a collection that contains all the columns in the control.

public UXGridViewLength ColumnWidth { get; set; }

Gets or sets the standard width or automatic sizing mode of columns in the control.

public Style ContextMenuStyle { get; set; }

Gets or sets the style that is used when rendering the context menu element.

public CornerRadius CornerRadius { get; set; }

Represents the radius of a border's corner. The radius can't be negative.

public UXGridViewColumn CurrentColumn { get; set; }

Gets or sets the column that contains the current cell.

public ICommand DeleteRowCommand { get; set; }

Gets or sets command that will be invoked when deleting a row.

public ICommand DoubleClickCommand { get; set; }

Gets or sets the command that will be invoked when validating a row.

public Style DragIndicatorStyle { get; set; }

Gets or sets the style that is used when rendering the drag indicator that is displayed while dragging column headers.

public Style DropLocationIndicatorStyle { get; set; }

Gets or sets the style that is used when rendering the column headers.

public EditEnterKeyAction EditEnterKeyAction { get; set; }

Gets or sets a value that determines the action when enter key is pressed during editing mode.

public EditKeyGesture EditKeyGesture { get; set; }

Gets or sets a value that determines the key gesture used to enter the editing mode.

public EditMouseGesture EditMouseGesture { get; set; }

Gets or sets a value that determines the mouse gesture used to enter the editing mode.

public Visibility EmptyRowsVisibility { get; set; }

Gets or sets a value that determines the visibility of empty rows.

public bool EnableContextMenu { get; set; }

Gets or sets a value that determines whether context menus is enabled.

public bool EnableRowVirtualization { get; set; }

Gets or sets a value that determines whether row virtualization is enabled.

Remarks

To increase the overall performance, UXGridView implements row virtualization when rendering the rows. The main objective of this concept is to generate only the elements that will be displayed in the current viewport of UXGridView. This feature is particularly useful for scenarios when you are dealing with large dataset. Although the virtualization feature is recommended in most scenarios, there might be some scenarios where this feature is undesireable. To turn off the virtualization feature, you simply set the EnableRowVirtualization property to false.

 

public EnterKeyAction EnterKeyAction { get; set; }

Gets or sets a value that determines the action when enter key is pressed.

public bool EnterNewRowOnClick { get; set; }

Gets or sets the a value that determine whether UXGridView will enter edit on new empty row on single click.

public Visibility ErrorStatusVisibility { get; set; }

Gets or sets a value that determines whether the error status is visible.

public object ExpandedItem { get; set; }

Gets or sets the expanded item.

Remarks

When you expand the row details using any of the methods described above, the ExpandedItem property will be set to the data context of the expanded row. You can use this property for more advanced user interaction, such as displaying a hierarchical grid view.

 

public ICommand ExportCommand { get; set; }

Gets or sets command that will be invoked when exporting data.

Remarks

By default, the exporting processes only the data available in the client. Therefore if you enable server paging, you might not be able to export the complete data correctly. To address this challenge, you can implement the ExportCommand in the ViewModel and provide the desired data to the UXGridView property.

 

public UXGridViewCssStyleSelector ExportCssStyleSelector { get; set; }

Gets or sets the css style selector using for HTML exporting.

public IEnumerable ExportItems { get; set; }

Gets or sets the items to be exported.

Remarks

By default, the exporting processes only the data available in the client. Therefore if you enable server paging, you might not be able to export the complete data correctly. To address this challenge, you can implement the UXGridView in the ViewModel and provide the desired data to the ExportItems property.

 

public UXGridViewExportOptions ExportOptions { get; set; }

Gets or sets the export options.

public CompositeFilterDescriptorCollection FilterDescriptors { get; set; }

Gets or sets the descriptor object that encapsulates the filtering related information.

Remarks

Server data operation means that the data operation, such as sorting, filtering and paging; are processed in the server side. In this mode, UXGridView does not handle the data operation by its own. It will simply provide the query information allowing you to process it further to a data service. To use this mode, you set the UXDataPager property to Server. When this mode is selected, UXGridView will not attempt to perform the data operation on the given data source. Instead, it will store and distribute the query information on several properties such as FilterDescriptors, UXGridView and UXGridView property. When one of these properties change, the QueryChanged event of the associated QueryDescriptor will be raised. This allows you to streamline the query processing in a centralized function, which is one of the strong benefits of QueryDescriptor. For more information about QueryDescriptor, see QueryDescriptor Overview. To learn how to perform server-side sorting, filtering and paging using UXGridView, see How-to: Implement Server-side Sorting, Filtering and Paging using UXGridView.

 

public int FrozenColumnCount { get; set; }

Gets or sets the number of columns that the user cannot scroll horizontally.

Remarks

Frozen columns are columns that are always displayed and cannot be scrolled out of visibility. Frozen columns are always the leftmost columns in display order. You cannot drag frozen columns into the group of unfrozen columns or drag unfrozen columns into the group of frozen columns. To enable frozen columns in UXGridView, you need to set the FrozenColumnCount property to a value that represents the number of columns to freeze.

 

public GridLinesVisibility GridLinesVisibility { get; set; }

Gets or sets a value that indicates which grid lines separating inner cells are shown.

public Style GroupByBoxStyle { get; set; }

Gets or sets the style that is used when rendering the group by box element.

public Visibility GroupByBoxVisibility { get; set; }

Gets or sets a value that determines whether the group by box is visible.

public ObservableCollection<GroupDescription> GroupDescriptors { get; }

Gets collection of group descriptors.

Remarks

To set a predefined group, you can specify the GroupDescriptors property in either XAML or code. You can also specify the default sort direction through the SortDirection property.

 

public Visibility GroupFootersVisibility { get; set; }

Gets or sets a value that determines whether the group footer is visible.

Remarks

UXGridView supports data aggregate in both the column and group level. To display aggregate values of a UXGridViewBoundColumn at group level, you set the GroupFootersVisibility property to Visible and specify the UXGridViewBoundColumn property to one of the predefined value. You can also specify the string format to apply to the aggregate value by setting the UXGridViewBoundColumn property. If not specified, the aggregate value will be formatted using the value specified in the UXGridViewBoundColumn property.

 

public bool HasChanges { get; set; }

Gets or sets a value that indicates whether there are data changes or not.

Remarks

If you prefer to automatically update the records after each CUD operation, you can perform the server operation in the UXGridView, UXGridView and UXGridView respectively, and perhaps followed with the UXGridView to refresh the data. However, if you prefer a batch update, you can notify the UXGridView by setting the HasChanges property to true, and later call the SaveChanges method to save all changes in one server call.

 

public Brush HeaderAndRowSeparatorBrush { get; set; }

Gets or sets the Brush that is used to paint lines separating rows and column header.

public Brush HorizontalGridLinesBrush { get; set; }

Gets or sets the Brush that is used to paint grid lines separating rows.

public ScrollBarVisibility HorizontalScrollBarVisibility { get; set; }

Gets or sets a value that indicates how the horizontal scroll bar is displayed.

public ScrollMode HorizontalScrollMode { get; set; }

Gets or sets a value that determine the horizontal scroll mode.

Remarks

When you need to increase the scrolling performance even further, especially due to larger view port, you can set the HorizontalScrollMode and UXGridView properties to ScrollMode. In this mode, the row virtualization will be suspended during scrolling, and resumed when the scrolling completes. When you set the scroll mode to ScrollMode, you will see a visual indicator as you scroll through the vertical scroll bar. You can use the UXGridView or UXGridView to customize the appearance and template of the scrolling visual indicator.

 

public ICommand InsertRowCommand { get; set; }

Gets or sets command that will be invoked when inserting row.

public bool IsBusy { get; set; }

Gets or sets a value that indicates whether the control is busy.

public bool IsInsertingNewRow { get; set; }

Gets or sets a value that indicates whether the UXGridView new row is activated.

public Binding IsReadOnlyBinding { get; set; }

Gets or sets the binding that associates the IsReadOnly attribute with a property in the data source.

Remarks

You can specify whether a column is editable through the UXGridViewColumn property in UXGridViewColumn. In more advanced scenarios, you may also want to disable editing on certain columns based on the value of other columns. For examples, if a product has been discontinued, editing in all other columns should be disabled. To enforce the read only setting to a certain row in this scenario, you can use the IsReadOnlyBinding that is available in both UXGridView and UXGridViewBoundColumn level. The IsReadOnlyBinding at UXGridView level is used to evaluate whether the user can edit the row, while the IsReadOnlyBinding at UXGridViewBoundColumn level is used to evaluate whether the user can edit the cell.

 

public bool IsRefreshed { get; set; }

Gets or sets a value that indicates whether the UXGridView is refreshed.

public Binding IsRowDirtyBinding { get; set; }

Gets or sets the binding that associates the IsReadOnly attribute with a property in the data source.

public bool IsValid { get; }

Gets a value that indicates whether data in the grid is valid.

public IEnumerable ItemsSource { get; set; }

Gets or sets a collection that is used to generate the content of the control.

public LostFocusAction LostFocusAction { get; set; }

Gets or sets a value that determine the lost focus action when user lost focus during row editing.

Remarks

When you lost focus from an edited row, by default UXGridView will commit the current edit operation you can change this behavior by changing the LostFocusAction property and UXGridView property to CancelEdit. This setting will force UXGridView to cancel the current edit operation when the focus is lost from the edited row. UXGridView property determines the action for new row object, while UXGridView determines the action for existing rows.

 

public double MaxColumnWidth { get; set; }

Gets or sets the maximum width of columns in the UXGridView.

public double MinColumnWidth { get; set; }

Gets or sets the minimum width of columns in the UXGridView.

public object NewItem { get; set; }

Gets or sets the new item to be added.

public LostFocusAction NewRowLostFocusAction { get; set; }

Gets or sets a value that determine the lost focus action when user lost focus during new row editing.

Remarks

When you lost focus from an edited row, by default UXGridView will commit the current edit operation you can change this behavior by changing the UXGridView property and NewRowLostFocusAction property to CancelEdit. This setting will force UXGridView to cancel the current edit operation when the focus is lost from the edited row. NewRowLostFocusAction property determines the action for new row object, while UXGridView determines the action for existing rows.

 

public NewRowPosition NewRowPosition { get; set; }

Gets or sets a value that determine the position of new row.

public DataTemplate NoDataTemplate { get; set; }

Gets or sets the no data template.

public PageDescriptor PageDescriptor { get; set; }

Gets or sets the descriptor object that encapsulates the paging related information.

Remarks

Server data operation means that the data operation, such as sorting, filtering and paging; are processed in the server side. In this mode, UXGridView does not handle the data operation by its own. It will simply provide the query information allowing you to process it further to a data service. To use this mode, you set the UXDataPager property to Server. When this mode is selected, UXGridView will not attempt to perform the data operation on the given data source. Instead, it will store and distribute the query information on several properties such as UXGridView, UXGridView and PageDescriptor property. When one of these properties change, the QueryChanged event of the associated QueryDescriptor will be raised. This allows you to streamline the query processing in a centralized function, which is one of the strong benefits of QueryDescriptor. For more information about QueryDescriptor, see QueryDescriptor Overview. To learn how to perform server-side sorting, filtering and paging using UXGridView, see How-to: Implement Server-side Sorting, Filtering and Paging using UXGridView.

 

public bool PagerAutoEllipsis { get; set; }

Gets or sets a value that indicates whether to use an ellipsis as the last numeric button of UXDataPager.

Remarks

You can set the PagerAutoEllipsis property to true to automatically display an ellipsis when there are more pages to show.

 

public PagerDisplayMode PagerDisplayMode { get; set; }

Gets or sets a value that indicates how the UXDataPager user interface is displayed.

Remarks

You can customize the appearance of the UXDataPager by setting the PagerDisplayMode property. If you use a PagerDisplayMode that displays numeric buttons, you can change the number of buttons displayed by setting the UXGridView property.

 

public int PagerNumericButtonCount { get; set; }

Gets or sets a value that indicates the number of page buttons shown on the UXDataPager user interface.

Remarks

You can customize the appearance of the UXDataPager by setting the UXGridView property. If you use a UXGridView that displays numeric buttons, you can change the number of buttons displayed by setting the PagerNumericButtonCount property.

 

public Style PagerStyle { get; set; }

Gets or sets the style that is used when rendering the UXDataPager.

public int PageSize { get; set; }

Gets or sets a value that indicates the number of items displayed on a page.

public ICommand PrepareNewRowCommand { get; set; }

Gets or sets command that will be invoked when preparing new row.

public QueryOperation QueryOperation { get; set; }

Gets or sets a value that determines whether the filtering operation should be performed in client-side or server-side.

Remarks

It is often useful to view and interact with information in a data grid control such as UXGridView in different ways by grouping, sorting, filtering or paging the data. To handle this data operation, UXGridView provides two approaches that you can choose from by setting the QueryOperation property.

Client Data Operation

Client data operation means that the data operation, such as sorting, filtering and paging; are executed in the client side against the data source provided to the UXGridView. To use this operation, you set the QueryOperation property to Client. You typically use a collection that implements IPagedCollectionView as the data source or encapsulate the collection to a PagedCollectionView class. To learn how to perform client-side sorting, filtering and paging using UXGridView, see How-to: Implement Client-side Sorting, Filtering and Paging using UXGridView.

Server Data Operation

Server data operation means that the data operation, such as sorting, filtering and paging; are processed in the server side. In this mode, UXGridView does not handle the data operation by its own. It will simply provide the query information allowing you to process it further to a data service. To use this mode, you set the QueryOperation property to Server. When this mode is selected, UXGridView will not attempt to perform the data operation on the given data source. Instead, it will store and distribute the query information on several properties such as UXGridView, UXGridView and UXGridView property. When one of these properties change, the QueryChanged event of the associated QueryDescriptor will be raised. This allows you to streamline the query processing in a centralized function, which is one of the strong benefits of QueryDescriptor. For more information about QueryDescriptor, see QueryDescriptor Overview. To learn how to perform server-side sorting, filtering and paging using UXGridView, see How-to: Implement Server-side Sorting, Filtering and Paging using UXGridView.

 

public ICommand RefreshCommand { get; set; }

Gets or sets command that will be invoked when refreshing data.

public object RefreshCommandParameter { get; set; }

Gets or sets the parameter to pass to the RefreshCommand property.

public ICommand RejectChangesCommand { get; set; }

Gets or sets command that will be invoked when data changes is rejected.

public ICommand RejectRowCommand { get; set; }

Gets or sets command that will be invoked when row changes is rejected.

public UXGridViewResource ResourceOverride { get; set; }

Gets or sets the individual resource object to override the existing localized resource.

public Brush RowBackground { get; set; }

Gets or sets the Brush that is used to paint row backgrounds.

public DataTemplate RowDetailsTemplate { get; set; }

Gets or sets the template that is used to display the content of the details section of rows.

public DataTemplateSelector RowDetailsTemplateSelector { get; set; }

Gets or sets the template selector that is used to display the content of the details section of rows.

public RowDetailsVisibility RowDetailsVisibilityMode { get; set; }

Gets or sets a value that indicates when the details sections of rows are displayed.

public Style RowGroupFooterCellStyle { get; set; }

Gets or sets the style that is used when rendering the row group footer cell.

public StyleSelector RowGroupFooterCellStyleSelector { get; set; }

Gets or sets the style selector that is used when rendering the row group footer cell.

public Style RowGroupFooterStyle { get; set; }

Gets or sets the style that is used when rendering the row group footer.

public StyleSelector RowGroupFooterStyleSelector { get; set; }

Gets or sets the style selector that is used when rendering the row group footer.

public Style RowGroupHeaderStyle { get; set; }

Gets or sets the style that is used when rendering the row group header.

public StyleSelector RowGroupHeaderStyleSelector { get; set; }

Gets or sets the style selector that is used when rendering the row group header.

public DataTemplateSelector RowGroupHeaderTemplateSelector { get; set; }

Gets or sets the template selector that is used when rendering the row group headers.

public Style RowHeaderStyle { get; set; }

Gets or sets the style that is used when rendering the row header.

public Visibility RowHeaderVisibility { get; set; }

Gets or sets a value that determines whether the row header is visible.

public double RowHeaderWidth { get; set; }

Gets or sets the width of the row header column.

public double RowHeight { get; set; }

Gets or sets the standard height of rows in the control.

public Style RowStyle { get; set; }

Gets or sets the style that is used when rendering the rows.

public StyleSelector RowStyleSelector { get; set; }

Gets or sets the style selector that is used when rendering the rows.

public DataTemplate RowTemplate { get; set; }

Gets or sets the template that is used when rendering the rows.

public DataTemplateSelector RowTemplateSelector { get; set; }

Gets or sets the template selector that is used when rendering the rows.

public ICommand SaveChangesCommand { get; set; }

Gets or sets command that will be invoked when data changes is accepted.

public Style ScrollBarStyle { get; set; }

Gets or sets the style that is used when rendering the scrollbar.

public Brush ScrollCornerBackground { get; set; }

Gets or sets the Brush that is used to paint scroll corner element.

public Binding ScrollIndicatorBinding { get; set; }

Gets or sets the binding that associates the scroll indicator with property in the data source.

Remarks

When you need to increase the scrolling performance even further, especially due to larger view port, you can set the UXGridView and UXGridView properties to ScrollMode. In this mode, the row virtualization will be suspended during scrolling, and resumed when the scrolling completes. When you set the scroll mode to ScrollMode, you will see a visual indicator as you scroll through the vertical scroll bar. You can use the ScrollIndicatorBinding or ScrollIndicatorTemplate to customize the appearance and template of the scrolling visual indicator.

 

public Style ScrollIndicatorStyle { get; set; }

Gets or sets the style that is used when rendering the scroll indicator.

public DataTemplate ScrollIndicatorTemplate { get; set; }

Gets or sets the template that is used when rendering the scroll indicator.

public int SelectedIndex { get; set; }

Gets or sets the index of the current selection.

public object SelectedItem { get; set; }

Gets or sets the data item corresponding to the selected row.

public IEnumerable SelectedItems { get; set; }

Gets a list that contains the data items corresponding to the selected rows.

public SelectionMode SelectionMode { get; set; }

Gets or sets the selection behavior of the gridview.

public SelectionUnit SelectionUnit { get; set; }

Gets or sets the selection unit of gridview.

public SortDescriptionCollection SortDescriptions { get; }

Gets or sets the sort descriptions object that encapsulates the sorting related information.

Remarks

To implement a predefined sorting, you specify the SortDescriptions or UXGridView property in XAML depending on the value of the UXDataPager property. The SortDescriptions is used when the control is configured with client data operation, while the UXGridView is used for server data operation.

 

public SortDescriptorCollection SortDescriptors { get; set; }

Gets or sets the descriptor object that encapsulates the sorting related information.

Remarks

Server data operation means that the data operation, such as sorting, filtering and paging; are processed in the server side. In this mode, UXGridView does not handle the data operation by its own. It will simply provide the query information allowing you to process it further to a data service. To use this mode, you set the UXDataPager property to Server. When this mode is selected, UXGridView will not attempt to perform the data operation on the given data source. Instead, it will store and distribute the query information on several properties such as UXGridView, SortDescriptors and UXGridView property. When one of these properties change, the QueryChanged event of the associated QueryDescriptor will be raised. This allows you to streamline the query processing in a centralized function, which is one of the strong benefits of QueryDescriptor. For more information about QueryDescriptor, see QueryDescriptor Overview. To learn how to perform server-side sorting, filtering and paging using UXGridView, see How-to: Implement Server-side Sorting, Filtering and Paging using UXGridView.

 

public DataTemplate StatusBarCommandTemplate { get; set; }

Gets or sets the data template to apply to the StatusBarCommand.

public Style StatusBarStyle { get; set; }

Gets or sets the style that is used when rendering the statusbar.

public Visibility StatusBarVisibility { get; set; }

Gets or sets a value that determines whether the status bar is visible.

public ICommand UpdateCellCommand { get; set; }

Gets or sets command that will be invoked when updating a cell.

public ICommand UpdateRowCommand { get; set; }

Gets or sets command that will be invoked when updating a row.

public ICommand ValidateRowCommand { get; set; }

Gets or sets the command that will be invoked when validating a row.

public ObservableCollection<ValidationResult> ValidationResults { get; set; }

Gets or sets the validation results.

public Brush VerticalGridLinesBrush { get; set; }

Gets or sets the Brush that is used to paint grid lines separating columns.

public ScrollBarVisibility VerticalScrollBarVisibility { get; set; }

Gets or sets a value that indicates how the vertical scroll bar is displayed.

public ScrollMode VerticalScrollMode { get; set; }

Gets or sets a value that indicates the vertical scroll mode.

Remarks

When you need to increase the scrolling performance even further, especially due to larger view port, you can set the UXGridView and VerticalScrollMode properties to ScrollMode. In this mode, the row virtualization will be suspended during scrolling, and resumed when the scrolling completes. When you set the scroll mode to ScrollMode, you will see a visual indicator as you scroll through the vertical scroll bar. You can use the UXGridView or UXGridView to customize the appearance and template of the scrolling visual indicator.

 

Protected Properties

protected object CurrentItem { get; }

Gets the data item bound to the row that contains the current cell.

protected ProductInfo Product { get; }

Product Info.

Fields

public static readonly DependencyProperty AlternatingRowBackgroundProperty

Identifies the AlternatingRowBackground dependency property.

public static readonly DependencyProperty AreRowDetailsFrozenProperty

Identifies the AreRowDetailsFrozen dependency property.

public static readonly DependencyProperty AreRowGroupHeadersFrozenProperty

Identifies the AreRowGroupHeadersFrozen dependency property.

public static readonly DependencyProperty AutoEditOperationProperty

Identifies the AutoEditOperation dependency property.

public static readonly DependencyProperty AutoFocusOnErrorProperty

Identifies the AutoFocusOnError dependency property.

public static readonly DependencyProperty AutoGenerateColumnsProperty

Identifies the AutoGenerateColumns dependency property.

public static readonly DependencyProperty BusyLatencyProperty

Identifies the BusyLatency dependency property.

public static readonly DependencyProperty BusyOverlayBackgroundProperty

Identifies the BusyOverlayBackground dependency property.

public static readonly DependencyProperty CanUserAddRowsProperty

Identifies the CanUserAddRows dependency property.

public static readonly DependencyProperty CanUserBatchUpdateProperty

Identifies the CanUserBatchUpdate dependency property.

public static readonly DependencyProperty CanUserDeleteRowsProperty

Identifies the CanUserDeleteRows dependency property.

public static readonly DependencyProperty CanUserEditRowsProperty

Identifies the CanUserEditRows dependency property.

public static readonly DependencyProperty CanUserExportProperty

Identifies the CanUserExport dependency property.

public static readonly DependencyProperty CanUserFilterColumnsProperty

Identifies the CanUserFilterColumns dependency property.

public static readonly DependencyProperty CanUserGroupColumnsProperty

Identifies the CanUserGroupColumns dependency property.

public static readonly DependencyProperty CanUserPageProperty

Identifies the CanUserPage dependency property.

public static readonly DependencyProperty CanUserReorderColumnsProperty

Identifies the CanUserReorderColumns dependency property.

public static readonly DependencyProperty CanUserResizeColumnsProperty

Identifies the CanUserResizeColumns dependency property.

public static readonly DependencyProperty CanUserSortColumnsProperty

Identifies the CanUserSortColumns dependency property.

public static readonly DependencyProperty CellBusyTemplateProperty

Identifies the CellBusyTemplate dependency property.

public static readonly DependencyProperty CellEditingTemplateSelectorProperty

Identifies the CellEditingTemplateSelector dependency property.

public static readonly DependencyProperty CellStyleProperty

Identifies the CellStyle dependency property.

public static readonly DependencyProperty CellStyleSelectorProperty

Identifies the CellStyleSelector dependency property.

public static readonly DependencyProperty CellTemplateSelectorProperty

Identifies the CellTemplateSelector dependency property.

public static readonly DependencyProperty CheckedItemsProperty

Identifies the CheckedItems dependency property.

public static readonly DependencyProperty ClipboardCopyModeProperty

Identifies the ClipboardCopyMode dependency property.

public static readonly DependencyProperty ColumnFooterCellStyleProperty

Identifies the ColumnFooterCellStyle dependency property.

public static readonly DependencyProperty ColumnFooterCellStyleSelectorProperty

Identifies the ColumnFooterCellStyleSelector dependency property.

public static readonly DependencyProperty ColumnFooterStyleProperty

Identifies the ColumnFooterStyle dependency property.

public static readonly DependencyProperty ColumnFooterVisibilityProperty

Identifies the ColumnFooterVisibility dependency property.

public static readonly DependencyProperty ColumnHeaderHeightProperty

Identifies the ColumnHeaderHeight dependency property.

public static readonly DependencyProperty ColumnHeaderStyleProperty

Identifies the ColumnHeaderStyle dependency property.

public static readonly DependencyProperty ColumnHeaderStyleSelectorProperty

Identifies the ColumnHeaderStyleSelector dependency property.

public static readonly DependencyProperty ColumnHeaderTemplateSelectorProperty

Identifies the ColumnHeaderTemplateSelector dependency property.

public static readonly DependencyProperty ColumnHeaderVisibilityProperty

Identifies the ColumnHeaderVisibility dependency property.

public static readonly DependencyProperty ColumnsProperty

Identifies the Columns dependency property.

public static readonly DependencyProperty ColumnWidthProperty

Identifies the ColumnWidth dependency property.

public static readonly DependencyProperty ContextMenuStyleProperty

Identifies the ContextMenuStyle dependency property.

public static readonly DependencyProperty CornerRadiusProperty

Identifies the CornerRadius dependency property.

public static readonly DependencyProperty DeleteRowCommandProperty

Identifies the DeleteRowCommand dependency property.

public static readonly DependencyProperty DoubleClickCommandProperty

Identifies the DoubleClickCommand dependency property.

public static readonly DependencyProperty DragIndicatorStyleProperty

Identifies the DragIndicatorStyle dependency property.

public static readonly DependencyProperty DropLocationIndicatorStyleProperty

Identifies the DropLocationIndicatorStyle dependency property.

public static readonly DependencyProperty EditEnterKeyActionProperty

Identifies the EditEnterKeyAction dependency property.

public static readonly DependencyProperty EditKeyGestureProperty

Identifies the EditKeyGesture dependency property.

public static readonly DependencyProperty EditMouseGestureProperty

Identifies the EditMouseGesture dependency property.

public static readonly DependencyProperty EmptyRowsVisibilityProperty

Identifies the EmptyRowsVisibility dependency property.

public static readonly DependencyProperty EnableContextMenuProperty

Identifies the EnableContextMenu dependency property.

public static readonly DependencyProperty EnableRowVirtualizationProperty

Identifies the EnableRowVirtualization dependency property.

public static readonly DependencyProperty EnterKeyActionProperty

Identifies the EnterKeyAction dependency property.

public static readonly DependencyProperty EnterNewRowOnClickProperty

Identifies the EnterNewRowOnClick dependency property.

public static readonly DependencyProperty ErrorStatusVisibilityProperty

Identifies the ErrorStatusVisibility dependency property.

public static readonly DependencyProperty ExpandedItemProperty

Identifies the ExpandedItem dependency property.

public static readonly DependencyProperty ExportCommandProperty

Identifies the ExportCommand dependency property.

public static readonly DependencyProperty ExportCssStyleSelectorProperty

Identifies the ExportCssStyleSelector dependency property.

public static readonly DependencyProperty ExportItemsProperty

Identifies the ExportItems dependency property.

public static readonly DependencyProperty ExportOptionsProperty

Identifies the ExportOptions dependency property.

public static readonly DependencyProperty FilterDescriptorsProperty

Identifies the FilterDescriptors dependency property.

public static readonly DependencyProperty FrozenColumnCountProperty

Identifies the FrozenColumnCount dependency property.

public static readonly DependencyProperty GridLinesVisibilityProperty

Identifies the GridLinesVisibility dependency property.

public static readonly DependencyProperty GroupByBoxStyleProperty

Identifies the GroupByBoxStyle dependency property.

public static readonly DependencyProperty GroupByBoxVisibilityProperty

Identifies the GroupByBoxVisibility dependency property.

public static readonly DependencyProperty GroupFootersVisibilityProperty

Identifies the GroupFootersVisibility dependency property.

public static readonly DependencyProperty HasChangesProperty

Identifies the HasChanges dependency property.

public static readonly DependencyProperty HeaderAndRowSeparatorBrushProperty

Identifies the HeaderAndRowSeparatorBrush dependency property.

public static readonly DependencyProperty HorizontalGridLinesBrushProperty

Identifies the HorizontalGridLinesBrush dependency property.

public static readonly DependencyProperty HorizontalScrollBarVisibilityProperty

Identifies the HorizontalScrollBarVisibility dependency property.

public static readonly DependencyProperty HorizontalScrollModeProperty

Identifies the HorizontalScrollMode dependency property.

public static readonly DependencyProperty InsertRowCommandProperty

Identifies the InsertRowCommand dependency property.

public static readonly DependencyProperty IsBusyProperty

Identifies the IsBusy dependency property.

public static readonly DependencyProperty IsInsertingNewRowProperty

Identifies the IsInsertingNewRow dependency property.

public static readonly DependencyProperty IsRefreshedProperty

Identifies the IsRefreshed dependency property.

public static readonly DependencyProperty IsValidProperty

Identifies the IsValid dependency property.

public static readonly DependencyProperty ItemsSourceProperty

Identifies the ItemsSource dependency property.

public static readonly DependencyProperty LostFocusActionProperty

Identifies the LostFocusAction dependency property.

public static readonly DependencyProperty MaxColumnWidthProperty

Identifies the MaxColumnWidth dependency property.

public static readonly DependencyProperty MinColumnWidthProperty

Identifies the MinColumnWidth dependency property.

public static readonly DependencyProperty NewItemProperty

Identifies the NewItem dependency property.

public static readonly DependencyProperty NewRowLostFocusActionProperty

Identifies the NewRowLostFocusAction dependency property.

public static readonly DependencyProperty NewRowPositionProperty

Identifies the NewRowPosition dependency property.

public static readonly DependencyProperty NoDataTemplateProperty

Identifies the NoDataTemplate dependency property.

public static readonly DependencyProperty PageDescriptorProperty

Identifies the QueryDescriptor dependency property.

public static readonly DependencyProperty PagerAutoEllipsisProperty

Identifies the PagerAutoEllipsis dependency property.

public static readonly DependencyProperty PagerDisplayModeProperty

Identifies the PagerDisplayMode dependency property.

public static readonly DependencyProperty PagerNumericButtonCountProperty

Identifies the PagerNumericButtonCount dependency property.

public static readonly DependencyProperty PagerStyleProperty

Identifies the PagerStyle dependency property.

public static readonly DependencyProperty PageSizeProperty

Identifies the PageSize dependency property.

public static readonly DependencyProperty PrepareNewRowCommandProperty

Identifies the PrepareNewRowCommand dependency property.

public static readonly DependencyProperty QueryOperationProperty

Identifies the QueryOperation dependency property.

public static readonly DependencyProperty RefreshCommandParameterProperty

Identifies the RefreshCommandParameter dependency property.

public static readonly DependencyProperty RefreshCommandProperty

Identifies the RefreshCommand dependency property.

public static readonly DependencyProperty RejectChangesCommandProperty

Identifies the RejectChangesCommand dependency property.

public static readonly DependencyProperty RejectRowCommandProperty

Identifies the RejectRowCommand dependency property.

public static readonly DependencyProperty ResourceOverrideProperty

Identifies the ResourceOverride dependency property.

public static readonly DependencyProperty RowBackgroundProperty

Identifies the RowBackground dependency property.

public static readonly DependencyProperty RowDetailsTemplateProperty

Identifies the RowDetailsTemplate dependency property.

public static readonly DependencyProperty RowDetailsTemplateSelectorProperty

Identifies the RowDetailsTemplateSelector dependency property.

public static readonly DependencyProperty RowDetailsVisibilityModeProperty

Identifies the RowDetailsVisibilityMode dependency property.

public static readonly DependencyProperty RowGroupFooterCellStyleProperty

Identifies the RowGroupFooterCellStyle dependency property.

public static readonly DependencyProperty RowGroupFooterCellStyleSelectorProperty

Identifies the RowGroupFooterCellStyleSelector dependency property.

public static readonly DependencyProperty RowGroupFooterStyleProperty

Identifies the RowGroupFooterStyle dependency property.

public static readonly DependencyProperty RowGroupFooterStyleSelectorProperty

Identifies the RowGroupFooterStyleSelector dependency property.

public static readonly DependencyProperty RowGroupHeaderStyleProperty

Identifies the RowGroupHeaderStyle dependency property.

public static readonly DependencyProperty RowGroupHeaderStyleSelectorProperty

Identifies the RowGroupHeaderStyleSelector dependency property.

public static readonly DependencyProperty RowGroupHeaderTemplateSelectorProperty

Identifies the RowGroupHeaderTemplateSelector dependency property.

public static readonly DependencyProperty RowHeaderStyleProperty

Identifies the RowHeaderStyle dependency property.

public static readonly DependencyProperty RowHeaderVisibilityProperty

Identifies the RowHeaderVisibility dependency property.

public static readonly DependencyProperty RowHeaderWidthProperty

Identifies the RowHeaderWidth dependency property.

public static readonly DependencyProperty RowHeightProperty

Identifies the RowHeight dependency property.

public static readonly DependencyProperty RowStyleProperty

Identifies the RowStyle dependency property.

public static readonly DependencyProperty RowStyleSelectorProperty

Identifies the RowStyleSelector dependency property.

public static readonly DependencyProperty RowTemplateProperty

Identifies the RowTemplate dependency property.

public static readonly DependencyProperty RowTemplateSelectorProperty

Identifies the RowTemplateSelector dependency property.

public static readonly DependencyProperty SaveChangesCommandProperty

Identifies the SaveChangesCommand dependency property.

public static readonly DependencyProperty ScrollBarStyleProperty

Identifies the ScrollBarStyle dependency property.

public static readonly DependencyProperty ScrollCornerBackgroundProperty

Identifies the ScrollCornerBackground dependency property.

public static readonly DependencyProperty ScrollIndicatorStyleProperty

Identifies the ScrollIndicatorStyle dependency property.

public static readonly DependencyProperty ScrollIndicatorTemplateProperty

Identifies the ScrollIndicatorTemplate dependency property.

public static readonly DependencyProperty SelectedIndexProperty

Identifies the SelectedIndex dependency property.

public static readonly DependencyProperty SelectedItemProperty

Identifies the SelectedItem dependency property.

public static readonly DependencyProperty SelectedItemsProperty

Identifies the SelectedItems dependency property.

public static readonly DependencyProperty SelectionModeProperty

Identifies the SelectionMode dependency property.

public static readonly DependencyProperty SelectionUnitProperty

Identifies the SelectionUnit dependency property.

public static readonly DependencyProperty SortDescriptorsProperty

Identifies the SortDescriptors dependency property.

public static readonly DependencyProperty StatusBarCommandTemplateProperty

Identifies the StatusBarCommandTemplate dependency property.

public static readonly DependencyProperty StatusBarStyleProperty

Identifies the StatusBarStyle dependency property.

public static readonly DependencyProperty StatusBarVisibilityProperty

Identifies the StatusBarVisibility dependency property.

public static readonly DependencyProperty UpdateCellCommandProperty

Identifies the UpdateCellCommand dependency property.

public static readonly DependencyProperty UpdateRowCommandProperty

Identifies the UpdateRowCommand dependency property.

public static readonly DependencyProperty ValidateRowCommandProperty

Identifies the ValidateRowCommand dependency property.

public static readonly DependencyProperty ValidationResultsProperty

Identifies the ValidationResults dependency property.

public static readonly DependencyProperty VerticalGridLinesBrushProperty

Identifies the VerticalGridLinesBrush dependency property.

public static readonly DependencyProperty VerticalScrollBarVisibilityProperty

Identifies the VerticalScrollBarVisibility dependency property.

public static readonly DependencyProperty VerticalScrollModeProperty

Identifies the VerticalScrollMode dependency property.

Public Methods

public void AttachEventHandlers()

Attach built-in event handlers to control templates. Call this method if necessary.

public bool BeginEdit()

Causes the gridview to enter editing mode for the current cell and current row, unless the gridview is already in editing mode.

Return Types

true if the gridview enters editing mode; otherwise, false.

 

public bool BeginEdit(RoutedEventArgs editingEventArgs)

Causes the gridview to enter editing mode for the current cell and current row in the specified keyboard and mouse state.

Parameters

editingEventArgsProvides information about the keyboard or mouse gesture that prompted the method call. Can be null.

Return Types

true if the gridview enters editing mode; otherwise, false.

 

public bool CancelEdit()

Causes the gridview to cancel the current edit, restore the original value, and exit editing mode.

Return Types

true if the cancellation was successful; otherwise, false.

 

public bool CancelEdit(EditingUnit editingUnit)

Causes the gridview to cancel the current edit, restore the original value, and exit editing mode.

Parameters

editingUnitSpecifies whether to cancel editing for a Row or Cell.

Return Types

true if the operation was successful; otherwise, false.

 

public void CollapseRowGroup(CollectionViewGroup collectionViewGroup, bool collapseAllSubgroups)

Collapses gridview row groups.

Parameters

collectionViewGroupThe row group to collapse.
collapseAllSubgroupstrue to collapse all subgroups of the row group; otherwise, false.

 

public bool CommitEdit()

Causes the gridview to commit the current edit to the data source and exit editing mode.

Return Types

true if the edit was commit successfully; otherwise, false.

 

public bool CommitEdit(EditingUnit editingUnit, bool exitEditingMode)

Causes the gridview to commit the current edit to the data source, and optionally exit editing mode.

Parameters

editingUnitSpecifies whether to commit the edit for a Row or Cell.
exitEditingModetrue to exit editing mode; otherwise, false.

Return Types

true if the operation was successful; otherwise, false.

 

public void DetachedEventHandlers()

Detach built-in event handlers from control templates. Call this method if necessary.

public void Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public void ExpandRowGroup(CollectionViewGroup collectionViewGroup, bool expandAllSubgroups)

Expands gridview row groups.

Parameters

collectionViewGroupThe data in the row group.
expandAllSubgroupstrue to expand all subgroups of the row group; otherwise, false.

 

public void Export(Stream stream, UXGridViewExportOptions options)

Export data to the specified stream.

Parameters

streamData stream.
optionsExport options.

 

public void InitializeTemplates()

Initializes control templates.

public void OnApplyTemplate()

Builds the visual tree for the UXGridView when a new template is applied.

public void ScrollIntoView(object item, UXGridViewColumn column)

Scrolls the UXGridView vertically to display the row for the specified data item and scrolls the UXGridView horizontally to display the specified column.

Parameters

itemThe data item (row) to scroll to.
columnThe column to scroll to.

 

Protected Methods

protected Size ArrangeOverride(Size finalSize)

Provides the behavior for the Arrange pass of Silverlight layout.

Parameters

finalSizeThe final area within the parent that this object should use to arrange itself and its children.

Return Types

The actual size used once the element is arranged.

 

protected Size MeasureOverride(Size availableSize)

Provides the behavior for the Measure pass of Silverlight layout.

Parameters

availableSizeThe available size that this object can give to child objects. Infinity can be specified as a value to indicate that the object will size to whatever content is available.

Return Types

The size that this object determines it needs during layout, based on its calculations of child object allotted sizes.

 

protected void OnAutoGeneratingColumn(UXGridViewAutoGeneratingColumnEventArgs e)

Raises the AutoGeneratingColumn event.

Parameters

eThe event data.

 

protected void OnBeginningEdit(UXGridViewBeginningEditEventArgs e)

Raises the BeginningEdit event.

Parameters

eThe event data.

 

protected void OnCellEditEnded(UXGridViewCellEditEndedEventArgs e)

Raises the CellEditEnded event.

Parameters

eThe event data.

 

protected void OnCellEditEnding(UXGridViewCellEditEndingEventArgs e)

Raises the CellEditEnding event.

Parameters

eThe event data.

 

protected void OnColumnDisplayIndexChanged(UXGridViewColumnEventArgs e)

Raises the ColumnDisplayIndexChanged event.

Parameters

eThe event data.

 

protected void OnCopyingRowClipboardContent(UXGridViewRowClipboardEventArgs e)

Raises the CopyingRowClipboardContent event.

Parameters

eThe event data.

 

protected void OnCurrentCellChanged(ISRoutedEventArgs e)

Raises the CurrentCellChanged event.

Parameters

eThe event data.

 

protected void OnGotFocus(RoutedEventArgs e)

Called before the GotFocus event occurs.

Parameters

eThe data for the event.

 

protected void OnLoadingRow(UXGridViewRowEventArgs e)

Raises the LoadingRow event.

Parameters

eThe event data.

 

protected void OnLoadingRowDetails(UXGridViewRowDetailsEventArgs e)

Raises the LoadingRowDetails event.

Parameters

eThe event data.

 

protected void OnLoadingRowGroup(UXGridViewRowGroupHeaderEventArgs e)

Raises the LoadingRowGroup event.

Parameters

eThe event data.

 

protected void OnLostFocus(RoutedEventArgs e)

Called before the LostFocus event occurs.

Parameters

eThe data for the event.

 

protected void OnMouseWheel(MouseWheelEventArgs e)

Called before the MouseWheel event occurs.

Parameters

eThe data for the event.

 

protected void OnPreparingCellForEdit(UXGridViewPreparingCellForEditEventArgs e)

Raises the PreparingCellForEdit event.

Parameters

eThe event data.

 

protected void OnRowEditEnded(UXGridViewRowEditEndedEventArgs e)

Raises the RowEditEnded event.

Parameters

eThe event data.

 

protected void OnRowEditEnding(UXGridViewRowEditEndingEventArgs e)

Raises the RowEditEnding event.

Parameters

eThe event data.

 

protected void OnSelectionChanged(UXGridViewSelectionChangedEventArgs e)

Raises the SelectionChanged event.

Parameters

eThe event data.

 

protected void OnUnloadingRow(UXGridViewRowEventArgs e)

Raises the UnloadingRow event.

Parameters

eThe event data.

 

protected void OnUnloadingRowDetails(UXGridViewRowDetailsEventArgs e)

Raises the UnloadingRowDetails event.

Parameters

eThe event data.

 

protected void OnUnloadingRowGroup(UXGridViewRowGroupHeaderEventArgs e)

Raises the UnloadingRowGroup event.

Parameters

eThe event data.

 

Events

public event UXGridViewAutoGeneratingColumnEventHandler AutoGeneratingColumn

Occurs one time for each public, non-static property in the bound data type when the ItemsSource property is changed and the AutoGenerateColumns property is true.

public event UXGridViewBeginningEditEventHandler BeginningEdit

Occurs before a cell or row enters editing mode.

public event UXGridViewCellEditEndedEventHandler CellEditEnded

Occurs when a cell edit has been committed or canceled.

public event UXGridViewCellEditEndingEventHandler CellEditEnding

Occurs when a cell edit is ending.

public event UXGridViewColumnDisplayIndexChangedEventHandler ColumnDisplayIndexChanged

Occurs when the DisplayIndex property of a column changes.

public event UXGridViewColumnEventHandler ColumnReordered

Occurs when a UXGridView column has moved to a new position in the display order.

public event UXGridViewColumnReorderingEventHandler ColumnReordering

Occurs before a UXGridView column moves to a new position in the display order.

public event UXGridViewRowClipboardEventHandler CopyingRowClipboardContent

Occurs when the row is prepared for a clipboard copy operation.

public event ISRoutedEventHandler CurrentCellChanged

Occurs when a different cell becomes the current cell.

public event UXGridViewExportedEventHandler Exported

Occurs when data is succesfully exported.

public event UXGridViewExportingEventHandler Exporting

Occurs when data is being exported.

public event UXGridViewPreparingCellForEditEventHandler PreparingCellForEdit

Occurs when a cell in a column enters editing mode.

public event UXGridViewRowDetailsEventHandler RowDetailsVisibilityChanged

Occurs when the RowDetailsVisibilityMode property value changes.

public event UXGridViewRowEditEndedEventHandler RowEditEnded

Occurs when a row edit has been committed or canceled.

public event UXGridViewRowEditEndingEventHandler RowEditEnding

Occurs when a row edit is ending.

public event UXGridViewSelectionChangedEventHandler SelectionChanged

Occurs when the SelectedItem or SelectedItems property value changes.

CanUserAddRows Property

<Intersoft:UXGridView CanUserSortColumns="True">        
    <Intersoft:UXGridView.Columns>        
        <Intersoft:UXGridViewTextColumn Header="Customer ID" Binding="{Binding CustomerID}" CanUserSort="False"/>
        <Intersoft:UXGridViewTextColumn Header="Contact Name" Binding="{Binding ContactName}"/>
        <Intersoft:UXGridViewTextColumn Header="Contact Title" Binding="{Binding ContactTitle}"/>
        <Intersoft:UXGridViewTextColumn Header="CompanyName" Binding="{Binding CompanyName}"/>
    </Intersoft:UXGridView.Columns>
</Intersoft:UXGridView>

  • No labels