Back to Devexpress

GridView Properties

windowsforms-devexpress-dot-xtragrid-dot-views-dot-grid-dot-gridview-dot-underscore-properties.md

latest38.7 KB
Original Source

GridView Properties

Displays data in a tabular form.

NameDescription
AccessibleDescriptionGets or sets the object’s description used by accessibility client applications. Inherited from BaseView.
AccessibleNameReturns the object’s name used by accessibility client applications. Inherited from BaseView.
AccessibleRoleGets or sets the object’s accessible role. Inherited from BaseView.
ActiveEditorGets a View’s active editor. Inherited from ColumnView.
ActiveFilterGets an object which returns information on the filter criteria applied to the View. Inherited from ColumnView.
ActiveFilterCriteriaGets or sets the current filter criteria. Inherited from ColumnView.
ActiveFilterEnabledGets or sets whether the filtering functionality is enabled. Inherited from ColumnView.
ActiveFilterStringGets or sets the filter criteria in string format. Inherited from ColumnView.
AppearanceProvides access to the properties that control the appearance of the Grid View’s elements.
AppearancePrintProvides access to the properties that specify the appearances of the Grid View’s elements when they are printed/exported.
AutoFillColumnGets or sets the column that will fill the empty GridView space.
BaseInfoGets an object providing information for creating and initializing the View. Inherited from BaseView.
BestFitMaxRowCountThis property is obsolete. Use the GridOptionsView.BestFitMaxRowCount property instead.
BorderStyleGets or sets the border style for the current View. Inherited from BaseView.
CanRaiseEvents protectedGets a value indicating whether the component can raise an event. Inherited from Component.
CanShowEditorGets a value indicating whether a View can activate cell editors. Inherited from ColumnView.
ChildGridLevelNameGets or sets the name of the child level whose grouping state is displayed by the joined group panel.
ClipboardDataProviderGets an object that provides data for the clipboard in various formats (plain text, plain unicode text, rich text, CSV, BIFF8, HTML).
ColumnPanelRowHeightGets or sets the column header row height.
ColumnsProvides access to the collection of columns available for display within the View. Inherited from ColumnView.
ContainerGets the IContainer that contains the Component. Inherited from Component.
CustomizationFormProvides access to the Customization Form.
CustomizationFormBoundsSets the boundaries of the Customization Form. Reading this property may not return the actual boundaries of the Customization Form.
CustomizationRowCountObsolete. Gets or sets the number of headers that can be displayed within the Customization Form simultaneously.
DataControllerGets the data controller which implements data-aware operations. Inherited from BaseView.
DataRowCountGets how many data rows are contained within the View. Inherited from BaseView.
DataSourceGets the data source whose data is displayed by a View. Inherited from BaseView.
DefaultEditObsolete. The property is obsolete and you should not use it in your code. Inherited from ColumnView.
DefaultRelationIndexGets or sets the index of a detail view (detail tab) to process by default.
DesignMode protectedGets a value that indicates whether the Component is currently in design mode. Inherited from Component.
DetailHeightGets or sets the maximum height of a View when it serves as a detail View. Inherited from BaseView.
DetailLevelGets the nesting level of a View. Inherited from BaseView.
DetailTabHeaderLocationGets or sets the position of detail tabs within detail sections. Inherited from BaseView.
DetailVerticalIndentGets or sets the distance between master rows and Detail Sections, in pixels. This property is in effect in Classic detail mode (see GridOptionsDetail.DetailMode).
DisableCurrencyManagerGets or sets whether the View’s focused record is synchronized with the current position of the corresponding CurrencyManager object. Inherited from ColumnView.
EditableDetermines whether end-users can modify the View’s cell values.
EditingValueGets or sets the edited cell value.
EditingValueModifiedDetermines whether the edited cell value has been changed since the cell editor was activated. Inherited from ColumnView.
Events protectedGets the list of event handlers that are attached to this Component. Inherited from Component.
FilteredColumnsCountObsolete. Gets the number of columns that specify filtering conditions. Inherited from ColumnView.
FilterPanelTextGets the text displayed within the filter panel. Inherited from ColumnView.
FilterPopupMaxRecordsCountObsolete. Gets or sets the maximum number of records whose field values can be displayed within filter dropdowns. Inherited from ColumnView.
FilterPopupRowCountObsolete. Gets or sets the maximum number of items filter dropdowns can display at once. Inherited from ColumnView.
FindFilterTextGets or sets the query in the Find Panel. Inherited from ColumnView.
FindPanelItemsGets settings that allow you to display custom items within the Find Panel. Inherited from ColumnView.
FindPanelVisibleGets or sets whether the Find Panel is visible. This property is obsolete. Inherited from ColumnView.
FixedLineWidthGets or sets the width of frozen panel separators. The value must be in the range from 1 to 12 pixels.
FocusedColumnGets or sets the focused column/card field (in CardView and LayoutView Views). Inherited from ColumnView.
FocusedRowHandleGet or sets the focused row’s handle. Inherited from ColumnView.
FocusedRowModifiedGets a value indicating whether the focused row’s cell values have been modified since the row last received focus. Inherited from ColumnView.
FocusedValueGets the focused cell value. Inherited from ColumnView.
FocusRectStyleGets or sets a value specifying how the focus rectangle is painted.
FooterPanelHeightGets or sets the height of the view footer.
ForceDoubleClickGets or sets whether double-clicking within the View fires the DoubleClick event, even if a data cell has been double-clicked and its editor has been invoked on the first click. Inherited from BaseView.
FormatConditionsGets the collection of style format conditions for a View. Inherited from BaseView.
FormatRulesProvides access to a collection of conditional format rules, which allow you to change the appearance of individual cells or rows based on specific conditions. Inherited from ColumnView.
GridControlGets the grid control that owns a specific View. Inherited from BaseView.
GroupCountGets or sets how many columns are used to group data. Inherited from ColumnView.
GroupedColumnsGets the collection of columns involved in data grouping. Inherited from ColumnView.
GroupFooterShowModeObsolete. Gets or sets which groups display footers.
GroupFormatGets or sets the format rule that specifies a template for group row captions. You can build this template from custom text strings and the following placeholders: {0}, {1}, {2} and [#image].
GroupPanelTextGets or sets the text displayed within the group panel.
GroupRowHeightGets or sets the height of group rows.
GroupSummaryProvides access to group summary items.
GroupSummarySortInfoEnables sorting group rows by summary values.
GroupSummarySortInfoStateThis member supports the internal infrastructure and is not intended to be used directly from your code.
HasColumnErrorsIndicates whether the focused row or at least a single cell within the focused row has an error assigned. Inherited from ColumnView.
HorzScrollStepGets or sets the offset by which the View is scrolled horizontally when clicking scrollbar buttons.
HorzScrollVisibilityGets or sets a value specifying when the horizontal scrollbar should be displayed.
HtmlImagesGets or sets a collection of images that can be embedded in column/band headers, group rows and cells using the image tag. Inherited from BaseView.
ImagesGets or sets a collection of images that can be displayed within column headers and band headers. Inherited from ColumnView.
IndicatorWidthGets or sets the width of the row indicator panel.
IsAsyncInProgressGets whether async data loading is in progress. This property is in effect in Instant Feedback Mode. Inherited from ColumnView.
IsCellSelectGets or sets whether block selection is enabled.
IsDefaultStateGets a value indicating whether the View is in the default state.
IsDetailViewGets a value indicating whether the current View is a detail View. Inherited from BaseView.
IsDisposingGets whether the current object is being disposed of. Inherited from BaseView.
IsDraggingStateTests whether the end-user is currently dragging a column header.
IsEditFormVisibleGets whether an Edit Form is opened or closed
IsEditingIndicates whether a cell editor is active presently.
IsEditorFocusedGets a value indicating whether the active editor has input focus. Inherited from ColumnView.
IsEmptyDetermines whether a View contains any rows. Inherited from ColumnView.
IsFindPanelVisibleGets whether the Find Panel is visible. Inherited from ColumnView.
IsFirstRowDetermines whether the first visible data or group row is focused. Inherited from ColumnView.
IsFocusedRowLoadedGets whether the focused row’s data has been loaded (in Instant Feedback Mode). Inherited from ColumnView.
IsFocusedViewDetermines whether a View has input focus. Inherited from ColumnView.
IsLastRowDetermines whether the last visible data or group row is focused. Inherited from ColumnView.
IsLastVisibleRowDetermines whether the last visible row is focused. Inherited from ColumnView.
IsLevelDefaultGets whether the current View object is associated with a node within the GridControl.LevelTree at a non-root level. Inherited from BaseView.
IsLoadingGets a value indicating whether a specific View is being initialized at present time. Inherited from BaseView.
IsMultiSelectIndicates whether multiple rows are allowed to be selected.
IsServerModeGets whether the View obtains data in Server Mode. Inherited from BaseView.
IsShowDetailButtonsIndicates whether master-detail expand buttons are displayed within rows.
IsShowFilterPanelDetermines whether the filter panel is visible. Inherited from ColumnView.
IsSizingStateGets whether the end-user is resizing columns, rows or details at present time.
IsVisibleGets a value indicating whether the View is visible on screen.
IsZoomedViewDetermines whether the current detail View is maximized. Inherited from ColumnView.
LeftCoordGets or sets the offset by which the View is scrolled horizontally.
LevelIndentGets or sets the indent between group rows located at neighboring group levels, or between master and detail views.
LevelNameGets the name of the master-detail relationship corresponding to the current detail View. Inherited from BaseView.
LinkCountGets how many objects are connected to the View. Inherited from BaseView.
LoadingPanelVisibleGets or sets whether the animated Loading Panel indicating the data load process is displayed.
LookUpOwnerInherited from BaseView.
MRUFiltersThis property is not intended to be used in code. To edit MRUFilters, use the ColumnView.MRUFiltersInfo collection instead. Inherited from ColumnView.
MRUFiltersInfoProvides access to the recently applied filters list (see MRU Filter List article). Inherited from ColumnView.
NameGets or sets the View name. Inherited from BaseView.
NewItemRowTextGets or sets the text displayed within the new item row.
OptionsBehaviorProvides access to the View’s behavior options.
OptionsClipboardProvides access to the options that control row copy and paste operations.
OptionsCustomizationProvides access to the View’s customization options.
OptionsDetailProvides access to the View’s master-detail options.
OptionsDragDropContains settings related to user drag-and-drop operations.
OptionsEditFormProvides access to the settings of an Edit Form.
OptionsFilterProvides filtering options for this GridView.
OptionsFindProvides access to settings controlling the behavior and visibility of the Find Panel and its elements.
OptionsHintAllows you to enable/disable tooltips for truncated captions.
OptionsImageLoadContains properties that manage image loading in the current View.
OptionsLayoutProvides options which control how the current View’s layout is stored to/restored from a data store (a stream, xml file or system registry). Inherited from ColumnView.
OptionsMenuProvides access to the View’s menu options.
OptionsNavigationGets options regarding cell navigation.
OptionsPrintProvides options that control how the View is printed/exported.
OptionsScrollAnnotationsProvides access to options specific to scrollbar annotations.
OptionsSelectionProvides access to the View’s selection options.
OptionsViewProvides access to the View’s display options.
PaintAppearanceProvides access to the appearance settings currently used to paint the Grid View’s elements.
PaintStyleNameThis member is not supported. Inherited from BaseView.
ParentViewGets or sets a master View for the current View. Inherited from BaseView.
PressedColumnGets the column whose header is pressed.
PreviewFieldNameGets or sets the name of the field whose values are displayed within preview sections.
PreviewIndentGets or sets the horizontal offset of preview text.
PreviewLineCountGets or sets the number of text lines within preview sections.
PrevTopRowIndexGets the index of the previous top visible row after a vertical scroll operation.
RowCountReturns the number of visible Grid records.
RowFilterGets the expression used to filter the records displayed within the View. Inherited from ColumnView.
RowHeightGets or sets the cell height within data rows.
RowSeparatorHeightGets or sets the distance between rows.
ScrollStyleGets or sets a value specifying the behavior of the View’s scrollbars.
SelectedRowsCountGets the number of selected rows (cards). Inherited from ColumnView.
ShowButtonModeObsolete. Gets or sets a value specifying editor button display mode. Inherited from ColumnView.
SiteGets or sets the ISite of the Component. Inherited from Component.
SortedColumnsGets the collection of columns involved in sorting. Inherited from ColumnView.
SortInfoProvides access to the collection of sorted and grouping columns within the current View. Inherited from ColumnView.
SortInfoStateThis member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from ColumnView.
SourceRowGets a master row for a View. Inherited from BaseView.
SourceRowHandleGets the handle of a master row for a View. Inherited from BaseView.
SourceViewGets the pattern View used to create a clone View. Inherited from BaseView.
StateGets the View’s current state.
SynchronizeClonesGets or sets a value specifying whether this View’s clones have synchronized appearance and data representation settings. Inherited from BaseView.
TagGets or sets the data associated with the current View. Inherited from BaseView.
TopRowIndexGets or sets the top visible row.
TopRowPixelGets or sets the vertical scroll position, in pixels. This property is in effect if pixel-based scrolling is enabled.
UseAdvancedCustomizationForm staticGets or sets whether to use the advancedCustomization Form in all GridViews in the application. This property is in effect if a view’s UseAdvancedCustomizationForm property is set to Default.
UserCellPaddingGets or sets a Padding structure by which the default cell padding is adjusted.
VertScrollTipFieldNameGets or sets the field whose values are displayed within the vertical scrollbar’s tooltip.
VertScrollVisibilityGets or sets a value specifying when the View’s vertical scrollbar is visible.
ViewCaptionGets or sets the View Caption. Inherited from BaseView.
ViewCaptionHeightGets or sets the height of the View Caption region. Inherited from ColumnView.
ViewRectGets the bounding rectangle of the View’s visible area.
ViewRepositoryGets the View repository that owns the current View. Inherited from BaseView.
VisibleColumnsGets the visible column collection. Inherited from ColumnView.
WorkAsLookupThis member supports the .NET Framework infrastructure and is not intended to be used directly from your code. Inherited from BaseView.

See Also

GridView Class

GridView Members

DevExpress.XtraGrid.Views.Grid Namespace