DataControlBase Members

Serves as a base for classes that represents data-aware controls (e.g. GridControl).

Fields

Name Description
ActiveEditorProperty static

Identifies the DataControlBase.ActiveEditor dependency property.

ActualShowFilterPanelProperty static

Identifies the DataControlBase.ActualShowFilterPanel dependency property.

AllowColumnFilteringProperty static

Identifies the DataControlBase.AllowColumnFiltering dependency property.

AllowColumnMovingProperty static

Identifies the DataControlBase.AllowColumnMoving dependency property.

AllowCommitOnValidationAttributeErrorProperty static

Identifies the DataControlBase.AllowCommitOnValidationAttributeError dependency property.

AllowEditingProperty static

Identifies the DataControlBase.AllowEditing dependency property.

AllowLeaveInvalidEditorProperty static

Identifies the DataControlBase.AllowLeaveInvalidEditor dependency property.

AllowSortingProperty static

Identifies the DataControlBase.AllowSorting dependency property.

AutoFilterRowHandle
AutoGenerateColumnsProperty static

Identifies the DataControlBase.AutoGenerateColumns dependency property.

AutoScrollOnSortingProperty static

Identifies the DataControlBase.AutoScrollOnSorting dependency property.

CellStyleProperty static

Identifies the DataControlBase.CellStyle dependency property.

ColumnHeaderStyleProperty static

Identifies the DataControlBase.ColumnHeaderStyle dependency property.

ColumnHeaderTemplateProperty static

Identifies the DataControlBase.ColumnHeaderTemplate dependency property.

ColumnHeaderTemplateSelectorProperty static

Identifies the DataControlBase.ColumnHeaderTemplateSelector dependency property.

ColumnHeaderToolTipTemplateProperty static

Identifies the DataControlBase.ColumnHeaderToolTipTemplate dependency property.

CommandsProperty static

Identifies the DataControlBase.Commands dependency property.

CurrentGridProperty static

Identifies the DataControlBase.CurrentGrid dependency property.

CurrentItemProperty static

Identifies the DataControlBase.CurrentItem dependency property.

CurrentViewChangedListenerProperty static

Identifies the DataControlBase.CurrentViewChangedListener dependency property.

FilterCriteriaProperty static

Identifies the DataControlBase.FilterCriteria dependency property.

FilterPanelTextProperty static

Identifies the DataControlBase.FilterPanelText dependency property.

FilterStringProperty static

Identifies the DataControlBase.FilterString dependency property.

FixedTotalSummaryItemTemplateProperty static

Identifies the DataControlBase.FixedTotalSummaryItemTemplate dependency property.

FocusedBorderTemplateProperty static

Identifies the DataControlBase.FocusedBorderTemplate dependency property.

HasValidationErrorProperty static

Identifies the DataControlBase.HasValidationError dependency property.

IncrementalLoadingThresholdProperty static

Identifies the DataControlBase.IncrementalLoadingThreshold dependency property.

InvalidRowHandle

Gets the handle of a row which does not exist in a grid.

IsEditingProperty static

Identifies the DataControlBase.IsEditing dependency property.

IsFilterEnabledProperty static

Identifies the DataControlBase.IsFilterEnabled dependency property.

IsSynchronizedWithCurrentItemProperty static

Identifies the DataControlBase.IsSynchronizedWithCurrentItem dependency property.

ItemClickCommandProperty static

Identifies the DataControlBase.ItemClickCommand dependency property.

ItemNavigationModeProperty static

Identifies the DataControlBase.ItemNavigationMode dependency property.

ItemNavigationTargetTypeProperty static

Identifies the DataControlBase.ItemNavigationTargetType dependency property.

ItemsSourceProperty static

Identifies the DataControlBase.ItemsSource dependency property.

KeepFocusedRowOnUpdateProperty static

Identifies the DataControlBase.KeepFocusedRowOnUpdate dependency property.

NavigationStyleProperty static

Identifies the DataControlBase.NavigationStyle dependency property.

NewItemRowHandle
PreserveSortingProperty static

Identifies the DataControlBase.PreserveSorting dependency property.

SearchColumnsProperty static

Identifies the DataControlBase.SearchColumns dependency property.

SearchDelayProperty static

Identifies the DataControlBase.SearchDelay dependency property.

SearchPanelAllowFilterProperty static

Identifies the DataControlBase.SearchPanelAllowFilter dependency property.

SearchPanelClearOnCloseProperty static

Identifies the DataControlBase.SearchPanelClearOnClose dependency property.

SearchPanelCloseDelayProperty static

Identifies the DataControlBase.SearchPanelCloseDelay dependency property.

SearchPanelCriteriaOperatorTypeProperty static

Identifies the DataControlBase.SearchPanelCriteriaOperatorType dependency property.

SearchPanelFindFilterProperty static

Identifies the DataControlBase.SearchPanelFindFilter dependency property.

SearchPanelFindModeProperty static

Identifies the DataControlBase.SearchPanelFindMode dependency property.

SearchPanelHighlightResultsProperty static

Identifies the DataControlBase.SearchPanelHighlightResults dependency property.

SearchPanelHighlightingSettingsProperty static

Identifies the DataControlBase.SearchPanelHighlightingSettings dependency property.

SearchStringProperty static

Identifies the DataControlBase.SearchString dependency property.

SelectedItemHandleProperty static

Identifies the DataControlBase.SelectedItemHandle dependency property.

SelectedItemProperty static

Identifies the DataControlBase.SelectedItem dependency property.

SelectedItemsProperty static

Identifies the DataControlBase.SelectedItems dependency property.

SelectionModeProperty static

Identifies the DataControlBase.SelectionMode dependency property.

ShowColumnHeadersProperty static

Identifies the DataControlBase.ShowColumnHeaders dependency property.

ShowFilterPanelModeProperty static

Identifies the DataControlBase.ShowFilterPanelMode dependency property.

ShowFixedTotalSummaryProperty static

Identifies the DataControlBase.ShowFixedTotalSummary dependency property.

ShowLoadingPanelProperty static
ShowSearchPanelModeProperty static

Identifies the DataControlBase.ShowSearchPanelMode dependency property.

ShowTotalSummaryProperty static

Identifies the DataControlBase.ShowTotalSummary dependency property.

ShowValidationAttributeErrorsProperty static

Identifies the DataControlBase.ShowValidationAttributeErrors dependency property.

SummariesIgnoreNullValuesProperty static

Identifies the DataControlBase.SummariesIgnoreNullValues dependency property.

TotalSummaryContentStyleProperty static

Identifies the DataControlBase.TotalSummaryContentStyle dependency property.

TotalSummaryItemTemplateProperty static

Identifies the DataControlBase.TotalSummaryItemTemplate dependency property.

ValidationErrorProperty static

Identifies the DataControlBase.ValidationError dependency property.

VirtualizingCacheHeightProperty static

Identifies the DataControlBase.VirtualizingCacheHeight dependency property.

VirtualizingCacheWidthProperty static

Identifies the DataControlBase.VirtualizingCacheWidth dependency property.

Properties

Name Description
ActiveEditor

Gets the active editor. This is a dependency property.

ActualShowFilterPanel

Gets whether the filter panel is displayed within a grid. This is a dependency property.

AllowColumnFiltering

Gets or sets whether an end-user can filter data by column. This is a dependency property.

AllowColumnMoving

Gets or sets whether an end-user is allowed to move columns by dragging their headers. This is a dependency property.

AllowCommitOnValidationAttributeError

Gets or sets whether or not a cell's value that has failed validation specified by the Data Annotations attribute(s), can be posted to a data source. This is a dependency property.

AllowEditing

Gets or sets whether end-users are allowed to change cell values. This is a dependency property.

AllowLeaveInvalidEditor

Gets or sets whether an editor that did not pass validation can lose focus. This is a dependency property.

AllowSorting

Gets or sets whether an end-user can sort data. This is a dependency property.

AutoGenerateColumns

Gets or sets whether columns should be created automatically for all fields in a data source. This is a dependency property.

AutoScrollOnSorting

Gets or sets whether a grid is automatically scrolled after the order of rows has been changed. This is a dependency property.

BottomAdditionalRowsCount
CellStyle

Gets or sets the style applied to data cells displayed within a grid. This is a dependency property.

ColumnHeaderStyle

Gets or sets the column header's style. This is a dependency property.

ColumnHeaderTemplate

Gets or sets the template that defines the presentation of column header content. This is a dependency property.

ColumnHeaderTemplateSelector

Gets or sets an object that chooses a column header template based on custom logic. This is a dependency property.

ColumnHeaderToolTipTemplate

Gets or sets the template that defines the presentation of a column header's tooltip. This is a dependency property.

Commands

Provides access to grid commands. This is a dependency property.

CurrentItem

Gets or sets the currently focused data row.

FilterCriteria

Gets or sets the grid's filter criteria. This is a dependency property.

FilterPanelText

Gets the text displayed within the Filter Panel. This is a dependency property.

FilterString

Gets or sets the grid's filter expression. This is a dependency property.

FixedSummariesLeft

Gets total summaries displayed within the Fixed Summary Panel and aligned to the left.

FixedSummariesRight

Gets total summaries displayed within the Fixed Summary Panel and aligned to the right.

FixedTotalSummaryItemTemplate

Gets or sets the template that defines the presentation of total summary items. This is a dependency property.

FocusedBorderTemplate

Gets or sets the template that defines the presentation of a focused row's border. This is a dependency property.

HasValidationError

Gets whether a validation error has been defined for the grid. This is a dependency property.

HeadersData

Gets the information about column headers.

IncrementalLoadingThreshold

Gets or sets the threshold range that governs when the grid will begin to prefetch more row items. This is a dependency property.

IsEditing

Gets whether the focused cell is currently being edited. This is a dependency property.

IsFilterEnabled

Gets or sets whether the current filter is enabled. This is a dependency property.

IsSynchronizedWithCurrentItem

Gets or sets whether a grid should keep the DataControlBase.SelectedItem synchronized with the current item in the Windows.UI.Xaml.Data.ICollectionView. This is a dependency property.

ItemClickCommand

Gets or sets the command to invoke when an item is clicked.

ItemNavigationMode

Gets or sets whether a single or double tap is needed to navigate to an item.

ItemNavigationTargetParameterBinding

Gets or sets a binding that defines a parameter to be passed to the target page, invoked when clicking an item.

ItemNavigationTargetType

Allows you to specify a page to be opened when an end-user clicks an item.

ItemsSource

Gets or sets the grid's data source. This is a dependency property.

KeepFocusedRowOnUpdate

Gets or sets whether the currently selected row retains focus when data is sorted, grouped or filtered.

NavigationStyle

Gets or sets whether row focusing is allowed. This is a dependency property.

PreserveSorting

Gets or sets whether clicking a column header clears the existing sort settings. This is a dependency property.

SearchColumns

Gets or sets the field names against which searches are performed by the Search Panel. This is a dependency property.

SearchDelay

Gets or sets the amount of time in milliseconds, after which a data search is initiated (in an automatic find mode). This is a dependency property.

SearchPanelAllowFilter

Gets or sets whether the grid displays only those records that match the search criteria. This is a dependency property.

SearchPanelClearOnClose

Gets or sets whether or not the search string is cleared when closing the Search Panel. This is a dependency property.

SearchPanelCloseDelay

Gets or sets the amount of time, in milliseconds, after which a Search Panel that doesn't contain any search criteria is closed. This is a dependency property.

SearchPanelCriteriaOperatorType

Gets or sets the logical operator type (AND or OR). This is a dependency property.

SearchPanelFindFilter

Gets or sets the type of the comparison operator used to create filter conditions. This is a dependency property.

SearchPanelFindMode

Gets or sets whether data searching starts automatically, or must be started manually. This is a dependency property.

SearchPanelHighlightResults

Gets or sets whether to highlight search results within located records. This is a dependency property.

SearchPanelHighlightingSettings

Gets or sets the font settings used to highlight the text that matches the search criteria. This is a dependency property.

SearchString

Gets or sets the search string specified within the Search Panel. This is a dependency property.

SelectedItem

Get or sets the currently focused data item.

SelectedItemHandle

Gets or sets the selected item's handle. This is a dependency property.

SelectedItems

Gets data objects that correspond to items currently selected within a grid.

SelectionMode

Gets or sets whether multiple row/cell selection is enabled. This is a dependency property.

ShowColumnHeaders

Gets or sets whether a grid displays column headers. This is a dependency property.

ShowFilterPanelMode

Gets or sets when the Filter Panel is displayed within a grid. This is a dependency property.

ShowFixedTotalSummary

Gets or sets whether or not the Fixed Summary Panel is displayed within the grid. This is a dependency property.

ShowLoadingPanel
ShowSearchPanelMode

Gets or sets when the Search Panel is shown within the grid. This is a dependency property.

ShowTotalSummary

Gets or sets whether to display the total summary panel.

ShowValidationAttributeErrors

Gets or sets whether or not error icons are displayed within cells that fail validation specified by the Data Annotations attribute(s). This is a dependency property.

SummariesIgnoreNullValues

Gets or sets whether null values must be ignored when calculating data summaries. This is a dependency property.

TopRowIndex

Gets or sets the index of the top visible row.

TotalSummaryContentStyle

Gets or sets the style applied to total summary items displayed within a View. This is a dependency property.

TotalSummaryData

Gets information about the total summary.

TotalSummaryItemTemplate

Gets or sets the template that defines the presentation of total summary items. This is a dependency property.

ValidationError

Provides access to the object, which contains information about the validation error. This is a dependency property.

VirtualizingCacheHeight

Gets or sets the height of buffer areas above and below the visible area of the grid to be rendered.

VirtualizingCacheWidth

Gets or sets the width of buffer areas above and below the visible area of the grid to be rendered. This is a dependency property.

VisibleRowCount

Gets the total number of rows displayed within the grid.

Methods

Name Description
BeginDataUpdate()

Prevents visual and internal data updates until the DataControlBase.EndDataUpdate method is called.

BeginInit()

Starts the control's runtime initialization.

BeginSelection()

Prevents selection updates until the DataControlBase.EndSelection method is called.

ClearColumnFilter(ColumnBase)

Removes the filter condition applied to the specified column.

ClearColumnFilter(String)

Removes the filter condition applied to the specified column.

ClearSorting()

Clears the sorting applied to the grid.

CollapseAllGroups()

Collapses all group rows.

CommitEditing()

Hides the active editor and posts all the changes made within the focused row to a data source if the row values are valid.

EndDataUpdate()

Enables visual and internal data updates after the DataControlBase.BeginDataUpdate method call, and updates the grid.

EndInit()

Ends the runtime initialization.

EndSelection()

Enables selection updates after calling the DataControlBase.BeginSelection method, and forces an immediate update.

Equals(Object) Determines whether the specified object is equal to the current object.
(Inherited from Object)
Equals(Object, Object) static Determines whether the specified object instances are considered equal.
(Inherited from Object)
ExpandAllGroups()

Expands all group rows.

GetCellElementByRowHandleAndColumn(Int32, ColumnBase)

Returns the specified cell's UI element.

GetCellElementByTreeElement(DependencyObject)

Returns a cell that contains the specified tree element.

GetCellValue(Int32, String)

Returns the value of the specified data cell.

GetColumnByTreeElement(DependencyObject)

Returns a column whose cell contains the specified tree element.

GetColumnFilterCriteria(ColumnBase)

Returns a filter applied to the specified column.

GetColumnFilterCriteria(String)

Returns a filter applied to the specified column.

GetColumnFilterString(ColumnBase)

Returns a filter expression applied to the specified column.

GetColumnFilterString(String)

Returns a filter expression applied to the specified column.

GetCurrentGrid(DependencyObject) static

Gets the value of the DataControlBase.CurrentGrid attached property for a specified DependencyObject.

GetCurrentViewChangedListener(DependencyObject) static

Gets the value of the DataControlBase.CurrentViewChangedListener attached property for a specified DependencyObject.

GetHashCode() Serves as the default hash function.
(Inherited from Object)
GetRowElementByRowHandle(Int32)

Returns a UI element that is the specified row.

GetRowState(Int32)

This member supports the internal infrastructure and is not intended to be used directly from your code.

GetSelectedCells()

Returns the selected data cells.

GetTotalSummaryValue(SummaryItemBase)

Returns the value of the specified total summary item.

GetType() Gets the Type of the current instance.
(Inherited from Object)
HideEditor()

Closes the active editor, discarding all the changes made.

IsCellSelected(Int32, ColumnBase)

Indicates whether the specified cell is selected.

IsItemSelected(Int32)

Indicates whether the specified item is selected.

MemberwiseClone() Creates a shallow copy of the current Object.
(Inherited from Object)
MergeColumnFilters(CriteriaOperator)

Combines the specified filter with the grid's current filter with the AND operator.

MergeColumnFilters(String)

Combines the specified filter with the grid's current filter with the AND operator.

MoveColumnTo(ColumnBase, Int32)

Moves the specified column to the specified position.

MoveFirstRow()

Moves focus to the first visible row within a grid.

MoveLastRow()

Moves focus to the last visible row within a grid.

MoveNextPage()

Moves focus forward to the bottom row displayed onscreen within a grid.

MoveNextRow()

Moves focus to the row following the one currently focused.

MovePrevPage()

Moves focus backward to the top row displayed onscreen within a grid.

MovePrevRow(Boolean)
MoveSelectedItem(Int32)

Selects the specified item.

PopulateColumns()

Creates columns for all fields in a bound data source.

PostEditor()

Saves the active editor's value to a data source without closing the editor.

ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance.
(Inherited from Object)
RefreshData()

Updates the control data.

ScrollIntoView(Int32)

Makes the specified row visible onscreen.

ScrollIntoView(Object)

Makes the specified row visible onscreen.

SelectAll()

Selects all items within a grid.

SelectCell(Int32, GridColumnBase)

Selects the cell.

SelectCells(Int32, GridColumnBase, Int32, GridColumnBase)

Selects multiple cells.

SelectItem(Int32)

Selects the specified item.

SelectItem(Object)

Selects the specified item.

SelectRange(Int32, Int32)

Selects multiple items, while preserving the current selection (if any).

SetCurrentGrid(DependencyObject, DataControlBase) static

Sets the value of the DataControlBase.CurrentGrid attached property to a specified DependencyObject.

SetCurrentViewChangedListener(DependencyObject, INotifyCurrentViewChanged) static

Sets the value of the DataControlBase.CurrentViewChangedListener attached property to a specified DependencyObject.

ShowEditor()

Activates the focused cell's inplace editor.

SortBy(String)

Sorts data by the values of the specified column.

ToString() Returns a string that represents the current object.
(Inherited from Object)
UnselectAll()

Unselects any selected items within a grid.

UnselectCell(Int32, GridColumnBase)

Unselects the specified cell.

UnselectCells(Int32, GridColumnBase, Int32, GridColumnBase)

Unselects the specified cells.

UnselectItem(Int32)

Unselects the specified item.

UnselectItem(Object)

Unselects the specified item.

UpdateTotalSummary()

Updates total summaries.

UpdateUnboundColumnValues(Int32)

Updates unbound column values in the specified row.

Events

Name Description
AutoGeneratedColumns

Occurs after the columns have been automatically generated.

AutoGeneratingColumn

Occurs each time an individual column is auto-generated.

BeforeLayoutRefresh

Enables you to lock down end-user capabilities that affect the onscreen position of the focused row (e.g. moving row focus, row scrolling, sorting, etc.).

ColumnsPopulated

Obsolete. Occurs after the columns have been automatically generated.

CurrentColumnChanged

Occurs after the focused column has been changed.

FilterChanged

Occurs after the grid's filter has been changed.

ItemsSourceChanged

Occurs after the DataControlBase.ItemsSource property has been changed.

PropertyChanged

Occurs every time any of the DataControlBase class properties have changed their value.

SelectedItemChanged

Occurs after the selected item has been changed.

SelectionChanged

Occurs after grid's selection has been changed.

ShowFilterPopup

Enables you to customize a column's filter dropdown.

Attached Properties

Name Description
CurrentGrid static

Gets or sets the data control currently used within a grid. This is a dependency property.

CurrentViewChangedListener static

This member supports the internal infrastructure and cannot be used directly from your code. This is a dependency property.

See Also