.NET Documentation
Sf
Behavior class that provides additional functionality for the SfDataGrid control.
Definition
Namespace: Aliquo.Windows.Controls
Assembly: Aliquo.Windows.Controls (in Aliquo.Windows.Controls.dll) Version: 5.0.9179.22656
Assembly: Aliquo.Windows.Controls (in Aliquo.Windows.Controls.dll) Version: 5.0.9179.22656
C#
public class SfDataGridBehavior : Behavior<SfDataGrid>VB
Public Class SfDataGridBehavior
Inherits Behavior(Of SfDataGrid)- Inheritance
- Object DispatcherObject DependencyObject Freezable Animatable Behavior BehaviorSfDataGrid SfDataGridBehavior
Remarks
Attach this behavior to the SfDataGrid control to enable the common features of data lists.
The following list describes some of the customizations implemented in this behavior class:
- Virtualization of filters, sorting and data summaries.
- Configuration of columns with dynamic fields.
- Visible field settings.
- Show the row index in the row header.
- Add fill column
- Freeze columns dynamically using drag and drop.
- Add top and bottom summary rows.
Constructors
| SfDataGridBehavior | Constructor class. |
Properties
| AddFillColumn | Gets or sets a value indicating whether to add the fill column. The default is . |
| AllowFrozenColumns | Gets or sets a value that indicates whether freezing columns is allowed. |
| AllowSettingFrozenColumns | Gets or sets a value that indicates whether setting frozen column is allowed in fields settings. |
| AutoResize | Gets or sets a value that indicates whether to reset automatic width calculation for all columns. |
| ColumnMaxWidth | Gets or sets the maximum limit for the auto-calculated width of the columns. |
| DynamicFields | Gets or sets a list of fields to dynamically create and configure the columns of the SfDataGrid control. |
| EnableFilterVirtualization | Gets or sets a value that indicates whether filter virtualization is enabled. |
| EnableSortVirtualization | Gets or sets a value that indicates whether sort virtualization is enabled. |
| EnableSummaryVirtualization | Gets or sets a value that indicates whether table summary row virtualization is enabled. |
| EnterKeyMode | Gets or sets the behavior of the Enter key when pressed in data cells. |
| FieldListName | Gets or sets a name that is used in the title of the fields setting window, for example "Customers." |
| GroupCaptionDescriptions | Gets or sets a collection of GroupCaptionDescription that describes the columns displayed as group captions. |
| SelectedItems | Gets or sets the selected items in the SfDataGrid control. |
| ShowRecordIndex | Gets or sets a value indicating whether to display the record index on the RowHeader column. |
| SuspendRedraw | Gets or sets a value that controls updating the view of the SfDataGrid control. |
| UnboundSummaryBottomRows | Gets or sets the collection of SummaryRow that are displayed as bottom summary rows.. |
| UnboundSummaryTopRows | Gets or sets the collection of SummaryRow that are displayed as top summary rows. |
| UseAdvancedFieldSettings | Indicates whether advanced field settings are used. |
| VirtualizedSummarySource | Gets or sets a collection that provides the values for the table summary row. |
| VisibleFields | Gets or sets a list of fields that determine the visible columns in the SfDataGrid control. |
| VisibleSummaryRow | Gets or sets a value indicating whether to display the table summary row. |
Methods
| AssociatedDataGridEquals | Determines whether the specified SfDataGrid object is equivalent to the current associated SfDataGrid object. |
| CancelAddNew | Cancels the new record being added to the associated SfDataGrid control. |
| ClearFilters | Clears filters from all columns of the associated SfDataGrid control. |
| CommitAddNew | Confirms the new record being added to the associated SfDataGrid control. |
| ConfigureFields | Displays the fields configuration window. |
| ContentAsAutoFilter | Sets the value of the selected cell as the autofilter for the column of the associated SfDataGrid control. |
| CreatetFieldSettingFromGridColumn | Gets a FieldSetting that corresponds to the data in the GridColumn of the given SfDataGrid. |
| FilterPredicatesToSQLFilter | Converts the filter predicates of the specified GridColumn and DataGrid into a SQL filter expression. |
| FilterToSQLFilter(SfDataGrid, Boolean) | Converts the filters on the columns in the specified SfDataGrid into a SQL filter expression. Uses MappingName to designate the name of the fields to be evaluated against the filter predicates. |
| FilterToSQLFilter(SfDataGrid, GridColumn, String, Boolean) | Converts the local filters of the specified GridColumn into a SQL filter expression. |
| GetDataViewConditions | Gets current information about the state and conditions of the data view of the associated SfDataGrid control. |
| GetFieldSettingsFromGridColumns | Gets a list of field settings from the columns of the indicated SfDataGrid control. |
| GetFilterElementSource | Gets the value for the attached property FilterElementSourceProperty |
| GetFilterElementTemplate | Gets the value of the attached property FilterElementTemplateProperty for the indicated column. |
| GetFilterMode | Gets the value of the attached property FilterModeProperty for the indicated column. |
| GetIsEnabledFilterVirtualization | Gets the value of the IsEnabledFilterVirtualization attached property. |
| GetNotSettableField | Gets the value of the attached NotSettableField property. |
| GetRecordIndexVisibility | Gets the value of the attached RecordIndexVisibility property. |
| GetShowAllFields | Gets the value indicating whether all fields are displayed. |
| GetShowCellToolTipMode | Gets the value of the ShowCellToolTipMode attached property for the specified column. |
| GetShowHeaderToolTipMode | Gets the value of the ShowHeaderToolTipMode attached property for the specified column. |
| GetUseEditableCellStyle | Gets the value of the editable cell style usage. |
| GetVirtualizedFilters | Gets the value of the attached VirtualizedFilters property. |
| GetVirtualizedFiltersFrom | Gets the value of the attached VirtualizedFiltersFrom property. |
| GetVirtualizedSortColumns | Gets the value of the attached VirtualizedSortColumns property. |
| Refresh | Recreates the view of the associated SfDataGrid control. |
| ScrollInView | Positions the view scroll to show the selected row and column. |
| ScrollInView(RowColumnIndex) | Positions the view scroll to show the selected cell. |
| SelectAddNewRow | Select the row to add new rows to in the associated SfDataGrid control. |
| SelectRow | Selects the row of an item in the associated SfDataGrid control. |
| SetFilterElementSource | Sets the value for the attached property FilterElementSourceProperty |
| SetFilterElementTemplate | Sets the value of the FilterElementTemplateProperty attached property for the indicated column. |
| SetFilterMode | Sets the value of the attached property FilterModeProperty for the indicated column. |
| SetNotSettableField | Sets the value of the attached NotSettableField property. |
| SetRecordIndexVisibility | Sets the value of the RecordIndexVisibility attached property. |
| SetShowAllFields | Sets the value indicating whether all fields are displayed. |
| SetShowCellToolTipMode | Sets the value of the ShowCellToolTipMode attached property for the indicated column. |
| SetShowHeaderToolTipMode | Sets the value of the ShowHeaderToolTipMode attached property for the indicated column. |
| SetUseEditableCellStyle | Sets the value of the editable cell style usage. |
| SetVirtualizedFilters | Sets the value of the attached VirtualizedFilters property. |
| SetVirtualizedFiltersFrom | Sets the value of the attached VirtualizedFiltersFrom property. |
| SetVirtualizedSortColumns | Sets the value of the attached VirtualizedSortColumns property. |
| SetVisibleFieldSettings | Sets the visible field settings for the specified SfDataGrid control. |
| SortColumnsToSQLOrder | Converts the specified sort list of columns (SortColumnDescription) into a SQL sort expression. Uses MappingName to designate the names of the fields to sort. |
| ToggleFreezeColumns | Moves or freezes the columns to the left of the active cell of the associated SfDataGrid control. |
| VirtualizedFilterToSQLFilter(SfDataGrid, Boolean) | Converts the virtualized filters on the columns of the specified SfDataGrid into a SQL filter expression. Uses MappingName to designate the name of the fields to be evaluated against the filter predicates. |
| VirtualizedFilterToSQLFilter(SfDataGrid, GridColumn, String, Boolean) | Converts the virtualized filters in the specified GridColumn into a SQL filter expression. |
| VirtualizedSortColumnsToSQLOrder | Converts the virtualized sort order of the columns in the specified SfDataGrid into a SQL sort expression. Uses MappingName to designate the names of the fields to sort. |
Events
| ConfigureFieldsAfter | Occurs after the field setting window is closed with the Accept or Reset option. |
| ConfigureFieldsBefore | Occurs before the field setting window is shown. |
| LoadedHasFinished | Occurs when the associated SfDataGrid control is loaded. |
| VirtualizedDataViewChanged | Occurs when the view of virtualized data is changed by a filtering, sorting, or field setting operation. |
| VisibleFieldsSettingChanged | Occurs when settings for visible fields have been changed. |
Fields
| AllowFrozenColumnsProperty | Identifies the dependency property AllowFrozenColumns. |
| AllowSettingFrozenColumnsProperty | Identifies the dependency property AllowSettingFrozenColumns |
| AutoResizeProperty | Identifies the dependency property AutoResize. |
| ColumnMaxWidthProperty | Identifies the dependency property ColumnMaxWidth. |
| DynamicFieldsProperty | Identifies the dependency property DynamicFields. |
| EnableFilterVirtualizationProperty | Identifies the dependency property EnableFilterVirtualization. |
| EnableSortVirtualizationProperty | Identifies the dependency property EnableSortVirtualization. |
| EnableSummaryVirtualizationProperty | Identifies the dependency property EnableSummaryVirtualization |
| EnterKeyModeProperty | Identifies the dependency property EnterKeyMode. |
| FieldListNameProperty | Identifies the dependency property FieldListName. |
| FilterElementSourceProperty | Attached property that allows you to set the data source for filters for a column in the SfDataGrid control. |
| FilterElementTemplateProperty | Attached property that allows you to set a custom DataTemplate that will be used to render the filter items for a column in the SfDataGrid control. |
| FilterModeProperty | Attached property that allows you to specify the FilterMode for a column of the SfDataGrid control. |
| GroupCaptionDescriptionsProperty | Identifies the dependency property GroupCaptionDescriptions |
| IsEnabledFilterVirtualizationProperty | Identifies the attached IsEnabledFilterVirtualization property. |
| NotSettableFieldProperty | Identifies the attached NotSettableField property. |
| RecordIndexVisibilityProperty | Identifies the attached RecordIndexVisibility property. |
| SelectedItemsProperty | Identifies the dependency property SelectedItems |
| ShowAllFieldsProperty | Identifies the dependency property ShowAllFieldsProperty. |
| ShowCellToolTipModeProperty | Attached property that allows you to specify how to display the ToolTip in the data cells of the SfDataGrid control. |
| ShowHeaderToolTipModeProperty | Attached property that allows you to specify how to display the ToolTip of a column header in the SfDataGrid control. |
| SuspendRedrawProperty | Identifies the dependency property SuspendRedraw |
| TableSummaryRowKey | Name that identifies the table summary row. |
| UnboundSummaryBottomRowKey | Name that identifies to the bottom unbound summary rows |
| UnboundSummaryBottomRowsProperty | Identifies the dependency property UnboundSummaryTopRows |
| UnboundSummaryTopRowKey | Name that identifies the top unbound summary row. |
| UnboundSummaryTopRowsProperty | Identifies the dependency property UnboundSummaryTopRows. |
| UseAdvancedFieldSettingsProperty | Identifies the dependency property UseAdvancedFieldSettings. |
| UseEditableCellStyleProperty | Property that specifies the use of editable cell style in the SfDataGrid. |
| VirtualizedFiltersFromProperty | Identifies the attached VirtualizedFiltersFrom property. |
| VirtualizedFiltersProperty | Identifies the attached VirtualizedFilters property. |
| VirtualizedSortColumnsProperty | Identifies the attached VirtualizedSortColumns property. |
| VirtualizedSummarySourceProperty | Identifies the dependency property VirtualizedSummarySource. |
| VisibleFieldsProperty | Identifies the dependency property VisibleFields. |
| VisibleSummaryRowProperty | Identifies the dependency property VisibleSummaryRow. |
Attached Properties
| FilterElementSource | Attached property that allows you to set the data source for filters for a column in the SfDataGrid control. |
| FilterElementTemplate | Attached property that allows you to set a custom DataTemplate that will be used to render the filter items for a column in the SfDataGrid control. |
| FilterMode | Attached property that allows you to specify the FilterMode for a column of the SfDataGrid control. |
| IsEnabledFilterVirtualization | Gets a value that indicates whether filter virtualization is enabled for an SfDataGrid control. |
| NotSettableField | Attached property that allows a column to be set as a non-configurable field. |
| RecordIndexVisibility | Gets or sets the visibility of the record index that is bound to the visibility property of the element that displays the row index in the RowHeader column. |
| ShowAllFields | Identifies the dependency property ShowAllFieldsProperty. |
| ShowCellToolTipMode | Attached property that allows you to specify how to display the ToolTip in the data cells of the SfDataGrid control. |
| ShowHeaderToolTipMode | Attached property that allows you to specify how to display the ToolTip of a column header in the SfDataGrid control. |
| UseEditableCellStyle | Property that specifies the use of editable cell style in the SfDataGrid. |
| VirtualizedFilters | Gets or sets a Dictionary that indicates the virtualized filters applied on the columns of the SfDataGrid control. |
| VirtualizedFiltersFrom | Gets or sets a Dictionary that identifies the source of virtualized filters, such as: FilterRow, AdvancedFilter, etc. |
| VirtualizedSortColumns | Gets or sets a list that contains the virtualized sorting of the SfDataGrid control. |
Extension Methods
| GetAttributeFromT |
Get attribute from a class.
(Defined by ObjectExtensions) |
| ValidateDataAnnotations |
Validate class with validator of DataAnnotations.
(Defined by ObjectExtensions) |