Back to Devexpress

GridControl Properties

wpf-devexpress-dot-xpf-dot-grid-dot-gridcontrol-dot-underscore-properties.md

latest67.9 KB
Original Source

GridControl Properties

The Data Grid control.

NameDescription
ActiveFilterInfoGets the information about the filter currently applied within the grid. This is a dependency property. Inherited from DataControlBase.
ActualGroupCountGets the actual number of grouping columns.
ActualHeightGets the rendered height of this element. Inherited from FrameworkElement.
ActualWidthGets the rendered width of this element. Inherited from FrameworkElement.
AllowCollectionViewGets or sets whether to allow processing collection views. This is a dependency property.
AllowColumnMRUFilterListGets or sets whether to display most recently used (MRU) filter items in the Drop-down Filter. This is a dependency property. Inherited from DataControlBase.
AllowDropGets 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.
AllowInitiallyFocusedRowGets or sets whether the GridControl is initially displayed with a focused row. This is a dependency property. Inherited from DataControlBase.
AllowLiveDataShapingGets 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.
AllowMRUFilterListGets or sets whether the grid’s MRU Filter List is enabled. This is a dependency property. Inherited from DataControlBase.
AllowRecursiveSelectionForCollapsedGroupsGets or sets whether rows within collapsed groups are selected when multiselection is enabled. This is a dependency property.
AllowUpdateTwoWayBoundPropertiesOnSynchronizationPrevents the DataControlBase.SelectedItem binding source from being updated during synchronization with the DataControlBase.ItemsSource. This is a dependency property. Inherited from DataControlBase.
AreAnyTouchesCapturedGets a value that indicates whether at least one touch is captured to this element. Inherited from UIElement.
AreAnyTouchesCapturedWithinGets 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.
AreAnyTouchesDirectlyOverGets a value that indicates whether at least one touch is pressed over this element. Inherited from UIElement.
AreAnyTouchesOverGets 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.
AutoExpandAllGroupsGets or sets whether all group rows are automatically expanded after each grouping operation. This is a dependency property.
AutoGenerateColumnsGets 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.
AutoPopulateColumnsObsolete. 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.
BackgroundGets or sets the brush used to paint the background of the GridControl. This is a dependency property.
BandGeneratorStyleGets or sets a style that contains settings common to all bands generated using different templates. This is a dependency property. Inherited from DataControlBase.
BandGeneratorTemplateGets or sets a template that describes grid bands. This is a dependency property. Inherited from DataControlBase.
BandGeneratorTemplateSelectorGets or sets the band template selector. This is a dependency property. Inherited from DataControlBase.
BandsGets a collection of the GridControl‘s bands.
BandsLayoutThis member supports the internal infrastructure and is not intended to be used directly from your code.
BandsSourceGets or sets the source from which the grid generates bands. This is a dependency property. Inherited from DataControlBase.
BindingGroupGets or sets the BindingGroup that is used for the element. Inherited from FrameworkElement.
BitmapEffectGets or sets a bitmap effect that applies directly to the rendered content for this element. This is a dependency property. Inherited from UIElement.
BitmapEffectInputGets 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.
CacheModeGets or sets a cached representation of the UIElement. Inherited from UIElement.
ClearCacheInherited from DataControlBase.
ClipGets or sets the geometry used to define the outline of the contents of an element. This is a dependency property. Inherited from UIElement.
ClipboardCopyModeGets or sets how data is copied to the clipboard. This is a dependency property. Inherited from DataControlBase.
ClipToBoundsGets 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.
ColumnGeneratorStyleGets or sets a style that contains settings common to all columns generated using different templates. This is a dependency property. Inherited from DataControlBase.
ColumnGeneratorTemplateGets or sets a template that describes grid columns. This is a dependency property. Inherited from DataControlBase.
ColumnGeneratorTemplateSelectorGets or sets a column template selector. This is a dependency property. Inherited from DataControlBase.
ColumnsGets a collection of the GridControl‘s columns.
ColumnsSourceGets or sets the source from which the grid generates columns. This is a dependency property. Inherited from DataControlBase.
CommandBindingsGets 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.
ConditionalFormattingResultForDesignTimeInherited from DataControlBase.
ContextMenuGets 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.
CriteriaConverterGets 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.
CurrentCellValueGet or sets the value associated with the currently focused cell. Inherited from DataControlBase.
CurrentColumnGets or sets the focused column. Inherited from DataControlBase.
CurrentItemGets or sets the currently focused data row. Inherited from DataControlBase.
CurrentProcessIdInherited from DataControlBase.
CursorGets or sets the cursor that displays when the mouse pointer is over this element. Inherited from FrameworkElement.
CustomColumnDisplayTextCommandGets or sets a command that customizes a data cell‘s display text.
CustomColumnGroupCommandGets or sets a command that applies custom rules to group rows.
CustomColumnSortCommandGets or sets a command that uses custom rules to sort rows.
CustomGroupDisplayTextCommandGets or sets a command that displays custom text in group rows.
CustomRowFilterCommandGets or sets a command that uses custom rules to filter rows.
CustomSummaryCommandGets or sets a command that calculates a custom summary.
CustomSummaryExistsCommandGets or sets a command that specifies which summaries should be calculated and displayed.
CustomUnboundColumnDataCommandGets or sets a command that populates unbound columns with data.
CustomUniqueValuesCommandGets or sets a command that populates a column’s Drop-down Filter with unique values. Inherited from DataControlBase.
DataAreaBackgroundGets or sets the brush used to paint the background of the GridControl/TreeListControl‘s data area. This is a dependency property. Inherited from DataControlBase.
DataContextGets or sets the data context for an element when it participates in data binding. Inherited from FrameworkElement.
DataControllerGets the data controller which implements data-aware operations.
DataSourceObsolete. Obsolete. Gets or sets the grid’s data source. This is a dependency property.
DefaultSortingGets or sets the name of a data field whose values are sorted by default. This is a dependency property. Inherited from DataControlBase.
DefaultStyleKey protectedGets or sets the key to use to reference the style for this control, when theme styles are used or defined. Inherited from FrameworkElement.
DeleteKeyBehaviorGets or sets the action executed when a user presses the Delete key. This is a dependency property. Inherited from DataControlBase.
DependencyObjectTypeGets the DependencyObjectType that wraps the CLR type of this instance. Inherited from DependencyObject.
DesignTimeColumnsListInherited from DataControlBase.
DesignTimeDataObjectTypeGets or sets the type of objects stored in a data source. This is a dependency property. Inherited from DataControlBase.
DesignTimeDataSourceRowCountGets or sets the number of temporary data rows displayed within the grid at design time. This is a dependency property. Inherited from DataControlBase.
DesignTimeIsFieldListAvailableInherited from DataControlBase.
DesignTimeShowSampleDataGets or sets whether sample data is displayed within the grid at design time. This is a dependency property. Inherited from DataControlBase.
DesignTimeUseDistinctSampleValuesGets or sets whether sample data rows contain distinct values. This is a dependency property. Inherited from DataControlBase.
DesiredSizeGets the size that this element computed during the measure pass of the layout process. Inherited from UIElement.
DetailDescriptorEnables master-detail representation within this GridControl.
DetectNestedPropertyChangesGets or sets whether the GridControl detects nested property changes. Inherited from DataControlBase.
DispatcherGets the Dispatcher this DispatcherObject is associated with. Inherited from DispatcherObject.
EffectGets or sets the bitmap effect to apply to the UIElement. This is a dependency property. Inherited from UIElement.
EnableRowUpdateOptimizationGets or sets whether the row update optimization mechanism is enabled.
EnableSmartColumnsGenerationGets or sets whether to enable smart columns generation feature. This is a dependency property. Inherited from DataControlBase.
FilterCriteriaGets or sets the grid’s filter criteria. This is a dependency property. Inherited from DataControlBase.
FilteredComponentGets an object that should be bound to a standalone FilterControl. Inherited from DataControlBase.
FilteringContextGets the context that binds a filter item to the GridControl ‘s data. Inherited from DataControlBase.
FilterStringGets or sets the grid’s filter expression. This is a dependency property. Inherited from DataControlBase.
FixedFilterSpecifies 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.
FlowDirectionGets or sets the direction that text and other user interface (UI) elements flow within any parent element that controls their layout. Inherited from FrameworkElement.
FocusableGets or sets a value that indicates whether the element can receive focus. This is a dependency property. Inherited from UIElement.
FocusVisualStyleGets 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.
FontFamilyGets or sets the font family of the control. Inherited from Control.
FontSizeGets or sets the font size. Inherited from Control.
FontStretchGets or sets the degree to which a font is condensed or expanded on the screen. Inherited from Control.
FontStyleGets or sets the font style. Inherited from Control.
FontWeightGets or sets the weight or thickness of the specified font. Inherited from Control.
ForceCursorGets 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.
ForegroundThis member supports the WPF infrastructure, and is not intended to be used directly from your code.
GroupCountGets or sets the number of grouping columns.
GroupSummaryGets a collection of group summary items.
GroupSummaryGeneratorTemplateGets or sets a template that describes group summaries. This is a dependency property.
GroupSummarySortInfoGets the information required to sort group rows by summary values.
GroupSummarySourceGets or sets the source from which the grid generates group summary items. This is a dependency property.
HandlesScrolling protectedGets a value that indicates whether a control supports scrolling. Inherited from Control.
HasAnimatedPropertiesGets a value indicating whether this element has any animated properties. Inherited from UIElement.
HasEffectiveKeyboardFocus protectedGets a value that indicates whether the UIElement has focus. Inherited from UIElement.
HeightGets or sets the suggested height of the element. Inherited from FrameworkElement.
HorizontalAlignmentGets 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.
HorizontalContentAlignmentThis member supports the WPF infrastructure, and is not intended to be used directly from your code.
ImplyNullLikeEmptyStringWhenFilteringGets or sets whether to allow filtering empty items using the Checked Filter Dropdown List. This is the dependency property. Inherited from DataControlBase.
InheritanceBehavior protectedGets or sets the scope limits for property value inheritance, resource key lookup, and RelativeSource FindAncestor lookup. Inherited from FrameworkElement.
InputBindingsGets the collection of input bindings associated with this element. Inherited from UIElement.
InputScopeGets or sets the context for input used by this FrameworkElement. Inherited from FrameworkElement.
IsAnyDetailGroupedGets whether any of detail grid data are grouped. This is a dependency property.
IsArrangeValidGets a value indicating whether the computed size and position of child elements in this element’s layout are valid. Inherited from UIElement.
IsAsyncOperationInProgressGets whether data is being loaded in Instant Feedback UI Mode. This is a dependency property.
IsEnabledGets or sets a value indicating whether this element is enabled in the user interface (UI). This is a dependency property. Inherited from UIElement.
IsEnabledCore protectedGets a value that becomes the return value of IsEnabled in derived classes. Inherited from UIElement.
IsFilterEnabledGets or sets whether the current filter is enabled. This is a dependency property. Inherited from DataControlBase.
IsFocusedGets a value that determines whether this element has logical focus. This is a dependency property. Inherited from UIElement.
IsGroupedGets whether the grid’s data is grouped.
IsHitTestVisibleGets 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.
IsInitializedGets 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.
IsInputMethodEnabledGets 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.
IsKeyboardFocusedGets a value indicating whether this element has keyboard focus. This is a dependency property. Inherited from UIElement.
IsKeyboardFocusWithinGets 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.
IsLoadedGets a value that indicates whether this element has been loaded for presentation. Inherited from FrameworkElement.
IsManipulationEnabledGets or sets a value that indicates whether manipulation events are enabled on this UIElement. Inherited from UIElement.
IsMeasureValidGets a value indicating whether the current size returned by layout measure is valid. Inherited from UIElement.
IsMouseCapturedGets a value indicating whether the mouse is captured to this element. This is a dependency property. Inherited from UIElement.
IsMouseCaptureWithinGets 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.
IsMouseDirectlyOverGets 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.
IsMouseOverGets 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.
IsRecursiveExpandGets or sets whether child group rows at all nesting levels are automatically expanded when expanding their parent group row. This is a dependency property.
IsSealedGets a value that indicates whether this instance is currently sealed (read-only). Inherited from DependencyObject.
IsStylusCapturedGets a value indicating whether the stylus is captured by this element. This is a dependency property. Inherited from UIElement.
IsStylusCaptureWithinGets 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.
IsStylusDirectlyOverGets 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.
IsStylusOverGets a value indicating whether the stylus cursor is located over this element (including visual child elements). This is a dependency property. Inherited from UIElement.
IsTabStopGets or sets a value that indicates whether a control is included in tab navigation. Inherited from Control.
IsVisibleGets a value indicating whether this element is visible in the user interface (UI). This is a dependency property. Inherited from UIElement.
ItemsSourceGets or sets the grid’s data source. This is a dependency property. Inherited from DataControlBase.
LanguageGets or sets localization/globalization language information that applies to an element. Inherited from FrameworkElement.
LayoutTransformGets or sets a graphics transformation that should apply to this element when layout is performed. Inherited from FrameworkElement.
MarginGets or sets the outer margin of an element. Inherited from FrameworkElement.
MaxHeightGets or sets the maximum height constraint of the element. Inherited from FrameworkElement.
MaxWidthGets or sets the maximum width constraint of the element. Inherited from FrameworkElement.
MinHeightGets or sets the minimum height constraint of the element. Inherited from FrameworkElement.
MinWidthGets or sets the minimum width constraint of the element. Inherited from FrameworkElement.
MRUColumnFilterListCountGets 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.
MRUFilterListGets a collection of the most recently used filters. Inherited from DataControlBase.
MRUFilterListCountGets or sets the maximum number of the most recently used (MRU) filter conditions the View stores. This is a dependency property. Inherited from DataControlBase.
MRUFiltersGets the collection of the most recently used filters. Inherited from DataControlBase.
NameGets 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.
OpacityGets 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.
OpacityMaskGets 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.
OptimizeSummaryCalculationSpecifies whether to optimize summary calculation. This is a dependency property.
OptimizeSummaryCalculationsOnItemChange staticGets or sets whether to optimize summary calculations when an item changes.
OverridesDefaultStyleGets or sets a value that indicates whether this element incorporates style properties from theme styles. Inherited from FrameworkElement.
OwnerDetailDescriptorGets or sets the detail descriptor that owns this data control. Inherited from DataControlBase.
PaddingThis member supports the WPF infrastructure, and is not intended to be used directly from your code.
ParentGets the logical parent element of this element. Inherited from FrameworkElement.
PersistIdGets a value that uniquely identifies this element. Inherited from UIElement.
RenderSizeGets (or sets) the final render size of this element. Inherited from UIElement.
RenderTransformGets or sets transform information that affects the rendering position of this element. This is a dependency property. Inherited from UIElement.
RenderTransformOriginGets 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.
ResourcesGets or sets the locally-defined resource dictionary. Inherited from FrameworkElement.
RestoreStateKeyFieldNameGets or sets a name of key field that is used to compare two objects when the state is restored. Inherited from DataControlBase.
RestoreStateOnSourceChangeGets or sets whether to retain the control’s select, focus, check, and group states when a new ItemsSource is assigned. Inherited from DataControlBase.
RunConditionalFormattingEditorInDesignTimeInherited from DataControlBase.
RunFilterStringEditorInDesignTimeInherited from DataControlBase.
SelectedItemGets 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.
SelectedItemsGets or sets a list of data objects that correspond to rows/nodes selected within a View. Inherited from DataControlBase.
SelectionModeGets or sets whether multiple row/cell selection is enabled. This is a dependency property. Inherited from DataControlBase.
ShowAllTableValuesInCheckedFilterPopupGets or sets whether filter dropdowns display all unique values in the View’s data source. This is a dependency property. Inherited from DataControlBase.
ShowAllTableValuesInFilterPopupGets or sets whether filter dropdowns display all unique values in the View’s data source. This is a dependency property. Inherited from DataControlBase.
ShowBorderGets or sets whether to show the grid’s border. This is a dependency property. Inherited from DataControlBase.
ShowLoadingPanelGets or sets whether the Loading Panel can be displayed within the grid control. This is a dependency property. Inherited from DataControlBase.
SnapsToDevicePixelsGets 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.
SortInfoProvides access to the collection of sorted and grouping columns.
StyleGets or sets the style used by this element when it is rendered. Inherited from FrameworkElement.
StylusPlugIns protectedGets a collection of all stylus plug-in (customization) objects associated with this element. Inherited from UIElement.
SupportDomainDataSourceThis member supports the internal infrastructure and is not intended to be used directly from your code. Inherited from DataControlBase.
TabIndexGets 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.
TagGets or sets an arbitrary object value that can be used to store custom information about this element. Inherited from FrameworkElement.
TemplateGets or sets a control template. Inherited from Control.
TemplatedParentGets 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.
ToolTipGets or sets the tool-tip object that is displayed for this element in the user interface (UI). Inherited from FrameworkElement.
TotalSummaryAllows you to access the collection of total summary items.
TotalSummaryGeneratorTemplateGets or sets a template that describes total summaries. This is a dependency property. Inherited from DataControlBase.
TotalSummarySourceGets or sets the source from which the grid generates total summary items. This is a dependency property. Inherited from DataControlBase.
TouchesCapturedGets all touch devices that are captured to this element. Inherited from UIElement.
TouchesCapturedWithinGets all touch devices that are captured to this element or any child elements in its visual tree. Inherited from UIElement.
TouchesDirectlyOverGets all touch devices that are over this element. Inherited from UIElement.
TouchesOverGets all touch devices that are over this element or any child elements in its visual tree. Inherited from UIElement.
TriggersGets the collection of triggers established directly on this element, or in child elements. Inherited from FrameworkElement.
UidGets or sets the unique identifier (for localization) for this element. This is a dependency property. Inherited from UIElement.
UseFieldNameForSerializationGets or sets whether to use the column’s field name for serialization. This is a dependency property. Inherited from DataControlBase.
UseLayoutRoundingGets or sets a value that indicates whether layout rounding should be applied to this element’s size and position during layout. Inherited from FrameworkElement.
VerticalAlignmentGets 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.
VerticalContentAlignmentThis member supports the WPF infrastructure, and is not intended to be used directly from your code.
ViewGets or sets the grid’s view. This is a dependency property.
VisibilityGets or sets the user interface (UI) visibility of this element. This is a dependency property. Inherited from UIElement.
VisibleItemsGets a set of visible grid data items - all the items except ones that are filtered out. Inherited from DataControlBase.
VisibleRowCountGets the total number of rows/cards displayed within the grid. Inherited from DataControlBase.
VisualBitmapEffect protectedGets or sets the BitmapEffect value for the Visual. Inherited from Visual.
VisualBitmapEffectInput protectedGets or sets the BitmapEffectInput value for the Visual. Inherited from Visual.
VisualBitmapScalingMode protectedGets or sets the BitmapScalingMode for the Visual. Inherited from Visual.
VisualCacheMode protectedGets or sets a cached representation of the Visual. Inherited from Visual.
VisualChildrenCount protectedGets the number of visual child elements within this element. Inherited from FrameworkElement.
VisualClearTypeHint protectedGets or sets the ClearTypeHint that determines how ClearType is rendered in the Visual. Inherited from Visual.
VisualClip protectedGets or sets the clip region of the Visual as a Geometry value. Inherited from Visual.
VisualEdgeMode protectedGets or sets the edge mode of the Visual as an EdgeMode value. Inherited from Visual.
VisualEffect protectedGets or sets the bitmap effect to apply to the Visual. Inherited from Visual.
VisualOffset protectedGets or sets the offset value of the visual object. Inherited from Visual.
VisualOpacity protectedGets or sets the opacity of the Visual. Inherited from Visual.
VisualOpacityMask protectedGets or sets the Brush value that represents the opacity mask of the Visual. Inherited from Visual.
VisualParent protectedGets the visual tree parent of the visual object. Inherited from Visual.
VisualScrollableAreaClip protectedGets or sets a clipped scrollable area for the Visual. Inherited from Visual.
VisualTextHintingMode protectedGets or sets the TextHintingMode of the Visual. Inherited from Visual.
VisualTextRenderingMode protectedGets or sets the TextRenderingMode of the Visual. Inherited from Visual.
VisualTransform protectedGets or sets the Transform value for the Visual. Inherited from Visual.
VisualXSnappingGuidelines protectedGets or sets the x-coordinate (vertical) guideline collection. Inherited from Visual.
VisualYSnappingGuidelines protectedGets or sets the y-coordinate (horizontal) guideline collection. Inherited from Visual.
WidthGets or sets the width of the element. Inherited from FrameworkElement.

See Also

GridControl Class

GridControl Members

DevExpress.Xpf.Grid Namespace