Skip to main content

GridControl Properties

The Data Grid control.
Name Description
ActiveFilterInfo Gets the information about the filter currently applied within the grid. This is a dependency property. Inherited from DataControlBase.
ActualGroupCount Gets the actual number of grouping columns.
ActualHeight Gets the rendered height of this element. Inherited from FrameworkElement.
ActualWidth Gets the rendered width of this element. Inherited from FrameworkElement.
AllowCollectionView Gets or sets whether to allow processing collection views. This is a dependency property.
AllowColumnMRUFilterList Gets or sets whether to display most recently used (MRU) filter items in the Drop-down Filter. This is a dependency property. Inherited from DataControlBase.
AllowDrop Gets or sets a value indicating whether this element can be used as the target of a drag-and-drop operation. This is a dependency property. Inherited from UIElement.
AllowInitiallyFocusedRow Gets or sets whether the GridControl is initially displayed with a focused row. This is a dependency property. Inherited from DataControlBase.
AllowLiveDataShaping Gets or sets whether the GridControl recalculates data shaping operations (for example, data sort and filter, summary calculation, and scrollbar annotation display) when you modify a data source outside the grid. Inherited from DataControlBase.
AllowMRUFilterList Gets or sets whether the grid’s MRU Filter List is enabled. This is a dependency property. Inherited from DataControlBase.
AllowRecursiveSelectionForCollapsedGroups Gets or sets whether rows within collapsed groups are selected when multiselection is enabled. This is a dependency property.
AllowUpdateTwoWayBoundPropertiesOnSynchronization Prevents the DataControlBase.SelectedItem binding source from being updated during synchronization with the DataControlBase.ItemsSource. This is a dependency property. Inherited from DataControlBase.
AreAnyTouchesCaptured Gets a value that indicates whether at least one touch is captured to this element. Inherited from UIElement.
AreAnyTouchesCapturedWithin Gets a value that indicates whether at least one touch is captured to this element or to any child elements in its visual tree. Inherited from UIElement.
AreAnyTouchesDirectlyOver Gets a value that indicates whether at least one touch is pressed over this element. Inherited from UIElement.
AreAnyTouchesOver Gets a value that indicates whether at least one touch is pressed over this element or any child elements in its visual tree. Inherited from UIElement.
AutoExpandAllGroups Gets or sets whether all group rows are automatically expanded after each grouping operation. This is a dependency property.
AutoGenerateColumns Gets or sets whether columns should be created automatically for all properties in the underlying data source when the View does not contain any columns. This is a dependency property. Inherited from DataControlBase.
AutoPopulateColumns Obsolete. Gets or sets whether columns should be created automatically for all fields in a data source if the grid doesn’t contain any columns. This is a dependency property. Inherited from DataControlBase.
Background Gets or sets the brush used to paint the background of the GridControl. This is a dependency property.
BandGeneratorStyle Gets or sets a style that contains settings common to all bands generated using different templates. This is a dependency property. Inherited from DataControlBase.
BandGeneratorTemplate Gets or sets a template that describes grid bands. This is a dependency property. Inherited from DataControlBase.
BandGeneratorTemplateSelector Gets or sets the band template selector. This is a dependency property. Inherited from DataControlBase.
Bands Gets a collection of the GridControl‘s bands.
BandsLayout This member supports the internal infrastructure and is not intended to be used directly from your code.
BandsSource Gets or sets the source from which the grid generates bands. This is a dependency property. Inherited from DataControlBase.
BindingGroup Gets or sets the BindingGroup that is used for the element. Inherited from FrameworkElement.
BitmapEffect Gets or sets a bitmap effect that applies directly to the rendered content for this element. This is a dependency property. Inherited from UIElement.
BitmapEffectInput Gets or sets an input source for the bitmap effect that applies directly to the rendered content for this element. This is a dependency property. Inherited from UIElement.
CacheMode Gets or sets a cached representation of the UIElement. Inherited from UIElement.
ClearCache Inherited from DataControlBase.
Clip Gets or sets the geometry used to define the outline of the contents of an element. This is a dependency property. Inherited from UIElement.
ClipboardCopyMode Gets or sets how data is copied to the clipboard. This is a dependency property. Inherited from DataControlBase.
ClipToBounds Gets or sets a value indicating whether to clip the content of this element (or content coming from the child elements of this element) to fit into the size of the containing element. This is a dependency property. Inherited from UIElement.
ColumnGeneratorStyle Gets or sets a style that contains settings common to all columns generated using different templates. This is a dependency property. Inherited from DataControlBase.
ColumnGeneratorTemplate Gets or sets a template that describes grid columns. This is a dependency property. Inherited from DataControlBase.
ColumnGeneratorTemplateSelector Gets or sets a column template selector. This is a dependency property. Inherited from DataControlBase.
Columns Gets a collection of the GridControl‘s columns.
ColumnsSource Gets or sets the source from which the grid generates columns. This is a dependency property. Inherited from DataControlBase.
CommandBindings Gets a collection of CommandBinding objects associated with this element. A CommandBinding enables command handling for this element, and declares the linkage between a command, its events, and the handlers attached by this element. Inherited from UIElement.
ConditionalFormattingResultForDesignTime Inherited from DataControlBase.
ContextMenu Gets or sets the context menu element that should appear whenever the context menu is requested through user interface (UI) from within this element. Inherited from FrameworkElement.
CriteriaConverter Gets or sets a converter that parses the GridControl‘s filter and returns a filter of a type used in your Model. This is a dependency property. Inherited from DataControlBase.
CurrentCellValue Get or sets the value associated with the currently focused cell. Inherited from DataControlBase.
CurrentColumn Gets or sets the focused column. Inherited from DataControlBase.
CurrentItem Gets or sets the currently focused data row. Inherited from DataControlBase.
CurrentProcessId Inherited from DataControlBase.
Cursor Gets or sets the cursor that displays when the mouse pointer is over this element. Inherited from FrameworkElement.
CustomColumnDisplayTextCommand Gets or sets a command that customizes a data cell‘s display text.
CustomColumnGroupCommand Gets or sets a command that applies custom rules to group rows.
CustomColumnSortCommand Gets or sets a command that uses custom rules to sort rows.
CustomGroupDisplayTextCommand Gets or sets a command that displays custom text in group rows.
CustomRowFilterCommand Gets or sets a command that uses custom rules to filter rows.
CustomSummaryCommand Gets or sets a command that calculates a custom summary.
CustomSummaryExistsCommand Gets or sets a command that specifies which summaries should be calculated and displayed.
CustomUnboundColumnDataCommand Gets or sets a command that populates unbound columns with data.
CustomUniqueValuesCommand Gets or sets a command that populates a column’s Drop-down Filter with unique values. Inherited from DataControlBase.
DataAreaBackground Gets or sets the brush used to paint the background of the GridControl/TreeListControl‘s data area. This is a dependency property. Inherited from DataControlBase.
DataContext Gets or sets the data context for an element when it participates in data binding. Inherited from FrameworkElement.
DataController Gets the data controller which implements data-aware operations.
DataSource Obsolete. Obsolete. Gets or sets the grid’s data source. This is a dependency property.
DefaultSorting Gets or sets the name of a data field whose values are sorted by default. This is a dependency property. Inherited from DataControlBase.
DefaultStyleKey protected Gets or sets the key to use to reference the style for this control, when theme styles are used or defined. Inherited from FrameworkElement.
DeleteKeyBehavior Gets or sets the action executed when a user presses the Delete key. This is a dependency property. Inherited from DataControlBase.
DependencyObjectType Gets the DependencyObjectType that wraps the CLR type of this instance. Inherited from DependencyObject.
DesignTimeColumnsList Inherited from DataControlBase.
DesignTimeDataObjectType Gets or sets the type of objects stored in a data source. This is a dependency property. Inherited from DataControlBase.
DesignTimeDataSourceRowCount Gets or sets the number of temporary data rows displayed within the grid at design time. This is a dependency property. Inherited from DataControlBase.
DesignTimeIsFieldListAvailable Inherited from DataControlBase.
DesignTimeShowSampleData Gets or sets whether sample data is displayed within the grid at design time. This is a dependency property. Inherited from DataControlBase.
DesignTimeUseDistinctSampleValues Gets or sets whether sample data rows contain distinct values. This is a dependency property. Inherited from DataControlBase.
DesiredSize Gets the size that this element computed during the measure pass of the layout process. Inherited from UIElement.
DetailDescriptor Enables master-detail representation within this GridControl.
DetectNestedPropertyChanges Gets or sets whether the GridControl detects nested property changes. Inherited from DataControlBase.
Dispatcher Gets the Dispatcher this DispatcherObject is associated with. Inherited from DispatcherObject.
Effect Gets or sets the bitmap effect to apply to the UIElement. This is a dependency property. Inherited from UIElement.
EnableRowUpdateOptimization Gets or sets whether the row update optimization mechanism is enabled.
EnableSmartColumnsGeneration Gets or sets whether to enable smart columns generation feature. This is a dependency property. Inherited from DataControlBase.
FilterCriteria Gets or sets the grid’s filter criteria. This is a dependency property. Inherited from DataControlBase.
FilteredComponent Gets an object that should be bound to a standalone FilterControl. Inherited from DataControlBase.
FilteringContext Gets the context that binds a filter item to the GridControl‘s data. Inherited from DataControlBase.
FilterString Gets or sets the grid’s filter expression. This is a dependency property. Inherited from DataControlBase.
FixedFilter Specifies the filter criteria that is always applied to the grid data and cannot be modified by the end-user. This is a dependency property. Inherited from DataControlBase.
FlowDirection Gets or sets the direction that text and other user interface (UI) elements flow within any parent element that controls their layout. Inherited from FrameworkElement.
Focusable Gets or sets a value that indicates whether the element can receive focus. This is a dependency property. Inherited from UIElement.
FocusVisualStyle Gets or sets a property that enables customization of appearance, effects, or other style characteristics that will apply to this element when it captures keyboard focus. Inherited from FrameworkElement.
FontFamily Gets or sets the font family of the control. Inherited from Control.
FontSize Gets or sets the font size. Inherited from Control.
FontStretch Gets or sets the degree to which a font is condensed or expanded on the screen. Inherited from Control.
FontStyle Gets or sets the font style. Inherited from Control.
FontWeight Gets or sets the weight or thickness of the specified font. Inherited from Control.
ForceCursor Gets or sets a value that indicates whether this FrameworkElement should force the user interface (UI) to render the cursor as declared by the Cursor property. Inherited from FrameworkElement.
Foreground This member supports the WPF infrastructure, and is not intended to be used directly from your code.
GroupCount Gets or sets the number of grouping columns.
GroupSummary Gets a collection of group summary items.
GroupSummaryGeneratorTemplate Gets or sets a template that describes group summaries. This is a dependency property.
GroupSummarySortInfo Gets the information required to sort group rows by summary values.
GroupSummarySource Gets or sets the source from which the grid generates group summary items. This is a dependency property.
HandlesScrolling protected Gets a value that indicates whether a control supports scrolling. Inherited from Control.
HasAnimatedProperties Gets a value indicating whether this element has any animated properties. Inherited from UIElement.
HasEffectiveKeyboardFocus protected Gets a value that indicates whether the UIElement has focus. Inherited from UIElement.
Height Gets or sets the suggested height of the element. Inherited from FrameworkElement.
HorizontalAlignment Gets or sets the horizontal alignment characteristics applied to this element when it is composed within a parent element, such as a panel or items control. Inherited from FrameworkElement.
HorizontalContentAlignment This member supports the WPF infrastructure, and is not intended to be used directly from your code.
ImplyNullLikeEmptyStringWhenFiltering Gets or sets whether to allow filtering empty items using the Checked Filter Dropdown List. This is the dependency property. Inherited from DataControlBase.
InheritanceBehavior protected Gets or sets the scope limits for property value inheritance, resource key lookup, and RelativeSource FindAncestor lookup. Inherited from FrameworkElement.
InputBindings Gets the collection of input bindings associated with this element. Inherited from UIElement.
InputScope Gets or sets the context for input used by this FrameworkElement. Inherited from FrameworkElement.
IsAnyDetailGrouped Gets whether any of detail grid data are grouped. This is a dependency property.
IsArrangeValid Gets a value indicating whether the computed size and position of child elements in this element’s layout are valid. Inherited from UIElement.
IsAsyncOperationInProgress Gets whether data is being loaded in Instant Feedback UI Mode. This is a dependency property.
IsEnabled Gets or sets a value indicating whether this element is enabled in the user interface (UI). This is a dependency property. Inherited from UIElement.
IsEnabledCore protected Gets a value that becomes the return value of IsEnabled in derived classes. Inherited from UIElement.
IsFilterEnabled Gets or sets whether the current filter is enabled. This is a dependency property. Inherited from DataControlBase.
IsFocused Gets a value that determines whether this element has logical focus. This is a dependency property. Inherited from UIElement.
IsGrouped Gets whether the grid’s data is grouped.
IsHitTestVisible Gets or sets a value that declares whether this element can possibly be returned as a hit test result from some portion of its rendered content. This is a dependency property. Inherited from UIElement.
IsInitialized Gets a value that indicates whether this element has been initialized, either during processing by a XAML processor, or by explicitly having its EndInit() method called. Inherited from FrameworkElement.
IsInputMethodEnabled Gets a value indicating whether an input method system, such as an Input Method Editor (IME), is enabled for processing the input to this element. Inherited from UIElement.
IsKeyboardFocused Gets a value indicating whether this element has keyboard focus. This is a dependency property. Inherited from UIElement.
IsKeyboardFocusWithin Gets a value indicating whether keyboard focus is anywhere within the element or its visual tree child elements. This is a dependency property. Inherited from UIElement.
IsLoaded Gets a value that indicates whether this element has been loaded for presentation. Inherited from FrameworkElement.
IsManipulationEnabled Gets or sets a value that indicates whether manipulation events are enabled on this UIElement. Inherited from UIElement.
IsMeasureValid Gets a value indicating whether the current size returned by layout measure is valid. Inherited from UIElement.
IsMouseCaptured Gets a value indicating whether the mouse is captured to this element. This is a dependency property. Inherited from UIElement.
IsMouseCaptureWithin Gets a value that determines whether mouse capture is held by this element or by child elements in its visual tree. This is a dependency property. Inherited from UIElement.
IsMouseDirectlyOver Gets a value that indicates whether the position of the mouse pointer corresponds to hit test results, which take element compositing into account. This is a dependency property. Inherited from UIElement.
IsMouseOver Gets a value indicating whether the mouse pointer is located over this element (including child elements in the visual tree). This is a dependency property. Inherited from UIElement.
IsRecursiveExpand Gets or sets whether child group rows at all nesting levels are automatically expanded when expanding their parent group row. This is a dependency property.
IsSealed Gets a value that indicates whether this instance is currently sealed (read-only). Inherited from DependencyObject.
IsStylusCaptured Gets a value indicating whether the stylus is captured by this element. This is a dependency property. Inherited from UIElement.
IsStylusCaptureWithin Gets a value that determines whether stylus capture is held by this element, or an element within the element bounds and its visual tree. This is a dependency property. Inherited from UIElement.
IsStylusDirectlyOver Gets a value that indicates whether the stylus position corresponds to hit test results, which take element compositing into account. This is a dependency property. Inherited from UIElement.
IsStylusOver Gets a value indicating whether the stylus cursor is located over this element (including visual child elements). This is a dependency property. Inherited from UIElement.
IsTabStop Gets or sets a value that indicates whether a control is included in tab navigation. Inherited from Control.
IsVisible Gets a value indicating whether this element is visible in the user interface (UI). This is a dependency property. Inherited from UIElement.
ItemsSource Gets or sets the grid’s data source. This is a dependency property. Inherited from DataControlBase.
Language Gets or sets localization/globalization language information that applies to an element. Inherited from FrameworkElement.
LayoutTransform Gets or sets a graphics transformation that should apply to this element when layout is performed. Inherited from FrameworkElement.
Margin Gets or sets the outer margin of an element. Inherited from FrameworkElement.
MaxHeight Gets or sets the maximum height constraint of the element. Inherited from FrameworkElement.
MaxWidth Gets or sets the maximum width constraint of the element. Inherited from FrameworkElement.
MinHeight Gets or sets the minimum height constraint of the element. Inherited from FrameworkElement.
MinWidth Gets or sets the minimum width constraint of the element. Inherited from FrameworkElement.
MRUColumnFilterListCount Gets or sets the maximum number of most recently used (MRU) filter items displayed in the column’s Drop-down Filter. This is a dependency property. Inherited from DataControlBase.
MRUFilterList Gets a collection of the most recently used filters. Inherited from DataControlBase.
MRUFilterListCount Gets or sets the maximum number of the most recently used (MRU) filter conditions the View stores. This is a dependency property. Inherited from DataControlBase.
MRUFilters Gets the collection of the most recently used filters. Inherited from DataControlBase.
Name Gets or sets the identifying name of the element. The name provides a reference so that code-behind, such as event handler code, can refer to a markup element after it is constructed during processing by a XAML processor. Inherited from FrameworkElement.
Opacity Gets or sets the opacity factor applied to the entire UIElement when it is rendered in the user interface (UI). This is a dependency property. Inherited from UIElement.
OpacityMask Gets or sets an opacity mask, as a Brush implementation that is applied to any alpha-channel masking for the rendered content of this element. This is a dependency property. Inherited from UIElement.
OptimizeSummaryCalculation Specifies whether to optimize summary calculation. This is a dependency property.
OptimizeSummaryCalculationsOnItemChange static Gets or sets whether to optimize summary calculations when an item changes.
OverridesDefaultStyle Gets or sets a value that indicates whether this element incorporates style properties from theme styles. Inherited from FrameworkElement.
OwnerDetailDescriptor Gets or sets the detail descriptor that owns this data control. Inherited from DataControlBase.
Padding This member supports the WPF infrastructure, and is not intended to be used directly from your code.
Parent Gets the logical parent element of this element. Inherited from FrameworkElement.
PersistId Gets a value that uniquely identifies this element. Inherited from UIElement.
RenderSize Gets (or sets) the final render size of this element. Inherited from UIElement.
RenderTransform Gets or sets transform information that affects the rendering position of this element. This is a dependency property. Inherited from UIElement.
RenderTransformOrigin Gets or sets the center point of any possible render transform declared by RenderTransform, relative to the bounds of the element. This is a dependency property. Inherited from UIElement.
Resources Gets or sets the locally-defined resource dictionary. Inherited from FrameworkElement.
RestoreStateKeyFieldName Gets or sets a name of key field that is used to compare two objects when the state is restored. Inherited from DataControlBase.
RestoreStateOnSourceChange Gets or sets whether to retain the control’s select, focus, check, and group states when a new ItemsSource is assigned. Inherited from DataControlBase.
RunConditionalFormattingEditorInDesignTime Inherited from DataControlBase.
RunFilterStringEditorInDesignTime Inherited from DataControlBase.
SelectedItem Gets or sets the focused data row (if row multi-selection is disabled); or the row that was selected first (if row multi-selection is enabled). Inherited from DataControlBase.
SelectedItems Gets or sets a list of data objects that correspond to rows/nodes selected within a View. Inherited from DataControlBase.
SelectionMode Gets or sets whether multiple row/cell selection is enabled. This is a dependency property. Inherited from DataControlBase.
ShowAllTableValuesInCheckedFilterPopup Gets or sets whether filter dropdowns display all unique values in the View’s data source. This is a dependency property. Inherited from DataControlBase.
ShowAllTableValuesInFilterPopup Gets or sets whether filter dropdowns display all unique values in the View’s data source. This is a dependency property. Inherited from DataControlBase.
ShowBorder Gets or sets whether to show the grid’s border. This is a dependency property. Inherited from DataControlBase.
ShowLoadingPanel Gets or sets whether the Loading Panel can be displayed within the grid control. This is a dependency property. Inherited from DataControlBase.
SnapsToDevicePixels Gets or sets a value that determines whether rendering for this element should use device-specific pixel settings during rendering. This is a dependency property. Inherited from UIElement.
SortInfo Provides access to the collection of sorted and grouping columns.
Style Gets or sets the style used by this element when it is rendered. Inherited from FrameworkElement.
StylusPlugIns protected Gets a collection of all stylus plug-in (customization) objects associated with this element. Inherited from UIElement.
SupportDomainDataSource This member supports the internal infrastructure and is not intended to be used directly from your code. Inherited from DataControlBase.
TabIndex Gets or sets a value that determines the order in which elements receive focus when the user navigates through controls by using the TAB key. Inherited from Control.
Tag Gets or sets an arbitrary object value that can be used to store custom information about this element. Inherited from FrameworkElement.
Template Gets or sets a control template. Inherited from Control.
TemplatedParent Gets a reference to the template parent of this element. This property is not relevant if the element was not created through a template. Inherited from FrameworkElement.
ToolTip Gets or sets the tool-tip object that is displayed for this element in the user interface (UI). Inherited from FrameworkElement.
TotalSummary Allows you to access the collection of total summary items.
TotalSummaryGeneratorTemplate Gets or sets a template that describes total summaries. This is a dependency property. Inherited from DataControlBase.
TotalSummarySource Gets or sets the source from which the grid generates total summary items. This is a dependency property. Inherited from DataControlBase.
TouchesCaptured Gets all touch devices that are captured to this element. Inherited from UIElement.
TouchesCapturedWithin Gets all touch devices that are captured to this element or any child elements in its visual tree. Inherited from UIElement.
TouchesDirectlyOver Gets all touch devices that are over this element. Inherited from UIElement.
TouchesOver Gets all touch devices that are over this element or any child elements in its visual tree. Inherited from UIElement.
Triggers Gets the collection of triggers established directly on this element, or in child elements. Inherited from FrameworkElement.
Uid Gets or sets the unique identifier (for localization) for this element. This is a dependency property. Inherited from UIElement.
UseFieldNameForSerialization Gets or sets whether to use the column’s field name for serialization. This is a dependency property. Inherited from DataControlBase.
UseLayoutRounding Gets or sets a value that indicates whether layout rounding should be applied to this element’s size and position during layout. Inherited from FrameworkElement.
VerticalAlignment Gets or sets the vertical alignment characteristics applied to this element when it is composed within a parent element such as a panel or items control. Inherited from FrameworkElement.
VerticalContentAlignment This member supports the WPF infrastructure, and is not intended to be used directly from your code.
View Gets or sets the grid’s view. This is a dependency property.
Visibility Gets or sets the user interface (UI) visibility of this element. This is a dependency property. Inherited from UIElement.
VisibleItems Gets a set of visible grid data items - all the items except ones that are filtered out. Inherited from DataControlBase.
VisibleRowCount Gets the total number of rows/cards displayed within the grid. Inherited from DataControlBase.
VisualBitmapEffect protected Gets or sets the BitmapEffect value for the Visual. Inherited from Visual.
VisualBitmapEffectInput protected Gets or sets the BitmapEffectInput value for the Visual. Inherited from Visual.
VisualBitmapScalingMode protected Gets or sets the BitmapScalingMode for the Visual. Inherited from Visual.
VisualCacheMode protected Gets or sets a cached representation of the Visual. Inherited from Visual.
VisualChildrenCount protected Gets the number of visual child elements within this element. Inherited from FrameworkElement.
VisualClearTypeHint protected Gets or sets the ClearTypeHint that determines how ClearType is rendered in the Visual. Inherited from Visual.
VisualClip protected Gets or sets the clip region of the Visual as a Geometry value. Inherited from Visual.
VisualEdgeMode protected Gets or sets the edge mode of the Visual as an EdgeMode value. Inherited from Visual.
VisualEffect protected Gets or sets the bitmap effect to apply to the Visual. Inherited from Visual.
VisualOffset protected Gets or sets the offset value of the visual object. Inherited from Visual.
VisualOpacity protected Gets or sets the opacity of the Visual. Inherited from Visual.
VisualOpacityMask protected Gets or sets the Brush value that represents the opacity mask of the Visual. Inherited from Visual.
VisualParent protected Gets the visual tree parent of the visual object. Inherited from Visual.
VisualScrollableAreaClip protected Gets or sets a clipped scrollable area for the Visual. Inherited from Visual.
VisualTextHintingMode protected Gets or sets the TextHintingMode of the Visual. Inherited from Visual.
VisualTextRenderingMode protected Gets or sets the TextRenderingMode of the Visual. Inherited from Visual.
VisualTransform protected Gets or sets the Transform value for the Visual. Inherited from Visual.
VisualXSnappingGuidelines protected Gets or sets the x-coordinate (vertical) guideline collection. Inherited from Visual.
VisualYSnappingGuidelines protected Gets or sets the y-coordinate (horizontal) guideline collection. Inherited from Visual.
Width Gets or sets the width of the element. Inherited from FrameworkElement.
See Also