Skip to main content
A newer version of this page is available. .

ColumnView Methods

The base class for Views that display tabular data.
Name Description
AddNewRow() Adds a new record.
ApplyColumnsFilter() Enables the filtering functionality.
ApplyFindFilter(String) Fills in the Find Panel with the specified query and applies it.
Assign(BaseView, Boolean) Copies properties and, optionally, event handlers from another View to the current one.
BeginDataUpdate() Prevents visual and internal data updates until the BaseView.EndDataUpdate method is called.
BeginInit() Starts the runtime View initialization. Inherited from BaseView.
BeginSelection() Prevents selection updates until the BaseView.EndSelection or the BaseView.CancelSelection method is called. Inherited from BaseView.
BeginSort() Prevents visual and internal data updates until the ColumnView.EndSort method is called.
BeginUpdate() Locks the BaseView object by preventing visual updates of the object and its elements until the EndUpdate method is called. Inherited from BaseView.
CalcColumnBestWidth(GridColumn) Returns the minimum width that the specified column needs to display its contents completely.
CalcHitInfo(Point) Returns information about the View elements located at the specified point. Inherited from BaseView.
CalcHitInfo(Int32, Int32) Returns information about the View elements located at the specified point. Inherited from BaseView.
CancelSelection() Enables selection updates after the BaseView.BeginSelection method call, but doesn’t force an immediate update. Inherited from BaseView.
CancelUpdateCurrentRow() Cancels changes made to focused row cells.
CanGroupColumn(GridColumn) Indicates whether grouping by a specific column is enabled.
CanResizeColumn(GridColumn) Indicates whether end-users can resize a specific column by dragging its right edge.
CanSortColumn(GridColumn) Indicates whether end-users can sort data by the specified column’s values.
CheckLoaded() Forces the grid control to finish its initialization. Inherited from BaseView.
ClearColumnErrors() Removes error descriptions for the focused row.
ClearColumnsFilter() Removes any filter conditions applied to the View’s columns.
ClearDocument() Clears a previously generated document for printing/exporting. Inherited from BaseView.
ClearFindFilter() Discards the query in the Find Panel.
ClearSelection() Unselects any selected rows in the current View when multiple row selection is in effect.
ClearSorting() Clears sorting applied to the View.
CloseEditor() Hides the active editor saving changes made. Inherited from BaseView.
Connect(Object) Connects the View to the specified object. Inherited from BaseView.
ConvertFormatConditionToFormatRules() Converts objects from the BaseView.FormatConditions collection to GridFormatRule objects and adds them to the ColumnView.FormatRules collection.
CopyToClipboard() Copies the selected record(s) to the Clipboard as text. Inherited from BaseView.
CreateDocument() Creates a print/export document from the View’s data. Inherited from BaseView.
CreateExportLink(IExportProvider) Returns an object that enables you to export a View’s data in a number of different formats. Inherited from BaseView.
CreateObjRef(Type) Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. Inherited from MarshalByRefObject.
DeleteRow(Int32) Deletes a data record or group row (in Grid Views) from the View. Also removes the corresponding row from a data source.
DeleteSelectedRows() Deletes the selected rows/cards in multiple selection mode or focused row/card in single selection mode.
Disconnect(Object) Removes the connection between the View and the specified object. Inherited from BaseView.
Dispose() Releases all resources used by the Component. Inherited from Component.
EndDataUpdate() Enables visual and internal data updates after the BaseView.BeginDataUpdate method call, and forces an immediate View update. Inherited from BaseView.
EndInit() Ends the runtime View initialization. Inherited from BaseView.
EndSelection() Enables selection updates after calling the BaseView.BeginSelection method and forces an immediate update. Inherited from BaseView.
EndSort() Enables visual and internal data updates after the ColumnView.BeginSort method call, and forces an immediate View update.
EndUpdate() Unlocks the BaseView object after a call to the BeginUpdate method and causes an immediate visual update. Inherited from BaseView.
EnsureRowLoaded(Int32, OperationCompleted) Loads a row (if it is not already loaded) and calls your callback method after that. This method is in effect in Instant Feedback Mode.
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object) Determines whether the specified object is equal to the current object. Inherited from Object.
Export(ExportTarget, Stream, ExportOptionsBase) Exports the data displayed by the GridControl.DefaultView (the GridControl.MainView or the currently maximized detail View) in the specified format to a stream, using the specified options. Inherited from BaseView.
Export(ExportTarget, Stream) Exports the data displayed by the GridControl.DefaultView (the GridControl.MainView or the currently maximized detail View) in the specified format to a stream. Inherited from BaseView.
Export(ExportTarget, String, ExportOptionsBase) Exports the data displayed by the GridControl.DefaultView (the GridControl.MainView or the currently maximized detail View) in the specified format to a file, using the specified options. Inherited from BaseView.
Export(ExportTarget, String) Exports the data displayed by the GridControl.DefaultView (the GridControl.MainView or the currently maximized detail View) in the specified format to a file. Inherited from BaseView.
ExportToCsv(Stream, CsvExportOptions) Exports the control’s data to the specified stream in CSV format using the specified options. Inherited from BaseView.
ExportToCsv(Stream) Exports the control’s data to the specified stream in CSV format. Inherited from BaseView.
ExportToCsv(String, CsvExportOptions) Exports the control’s data to the specified file in CSV format using the specified options. Inherited from BaseView.
ExportToCsv(String) Exports the control’s data to the specified file in CSV format. Inherited from BaseView.
ExportToDocx(Stream, DocxExportOptions) Exports the view’s data in the Office Open XML format (DOCX file) and sends it to the specified stream. Inherited from BaseView.
ExportToDocx(Stream) Exports the view’s data in the Office Open XML file format (DOCX file) and sends it to the specified stream. Inherited from BaseView.
ExportToDocx(String, DocxExportOptions) Exports the view’s data in the Office Open XML format and saves it to the specified DOCX file. Inherited from BaseView.
ExportToDocx(String) Exports the view’s data in the Office Open XML file format and saves it to the specified DOCX file. Inherited from BaseView.
ExportToExcelOld(String) Obsolete. Exports the GridControl.DefaultView‘s data to the specified file in MS Excel format. Inherited from BaseView.
ExportToHtml(Stream, HtmlExportOptions) Exports the GridControl.DefaultView‘s data to the specified stream in HTML format using the specified options. Inherited from BaseView.
ExportToHtml(Stream, String, String, Boolean) Obsolete. Exports the GridControl.DefaultView‘s data to a stream in HTML format using the specified character encoding, with the specified title. The output file can be compressed (secondary characters e.g. spaces are removed) if required. Inherited from BaseView.
ExportToHtml(Stream) Exports the GridControl.DefaultView‘s data to a stream in HTML format. Inherited from BaseView.
ExportToHtml(String, HtmlExportOptions) Exports the GridControl.DefaultView‘s data to the specified file in HTML format using the specified options. Inherited from BaseView.
ExportToHtml(String, String, String, Boolean) Obsolete. Exports the GridControl.DefaultView‘s data to the specified HTML file with the specified title, using the specified character encoding. The output file can be compressed (secondary characters e.g. spaces are removed) if required. Inherited from BaseView.
ExportToHtml(String, String) Obsolete. Exports the GridControl.DefaultView‘s data to an HTML file using the specified character encoding. Inherited from BaseView.
ExportToHtml(String) Exports the GridControl.DefaultView‘s data to the specified file in HTML format. Inherited from BaseView.
ExportToHtmlOld(String) Obsolete. Exports the GridControl.DefaultView‘s data to the specified file in HTML format. Inherited from BaseView.
ExportToMht(Stream, MhtExportOptions) Exports the GridControl.DefaultView‘s data to the specified stream in MHT format using the specified options. Inherited from BaseView.
ExportToMht(Stream, String, String, Boolean) Obsolete. Exports the GridControl.DefaultView‘s data to a stream in MHT format using the specified character encoding, with the specified title. The output file can be compressed (secondary characters e.g. spaces are removed) if required. Inherited from BaseView.
ExportToMht(String, MhtExportOptions) Exports the GridControl.DefaultView‘s data to the specified file in MHT format using the specified options. Inherited from BaseView.
ExportToMht(String, String, String, Boolean) Obsolete. Exports the GridControl.DefaultView‘s data to the specified file in MHT format using the specified character encoding, with the specified title. The output file can be compressed (secondary characters e.g. spaces are removed) if required. Inherited from BaseView.
ExportToMht(String, String) Obsolete. Exports the GridControl.DefaultView‘s data to the specified file in MHT format using the specified character encoding. Inherited from BaseView.
ExportToMht(String) Exports the GridControl.DefaultView‘s data to the specified file in MHT format. Inherited from BaseView.
ExportToPdf(Stream) Exports the GridControl.DefaultView‘s data to a stream in PDF format. Inherited from BaseView.
ExportToPdf(String, PdfExportOptions) Exports the GridControl.DefaultView‘s data to the specified file in PDF format. Inherited from BaseView.
ExportToPdf(String) Exports the GridControl.DefaultView‘s data to the specified file in PDF format. Inherited from BaseView.
ExportToRtf(Stream, RtfExportOptions) Inherited from BaseView.
ExportToRtf(Stream) Exports the GridControl.DefaultView‘s data to a stream in RTF format. Inherited from BaseView.
ExportToRtf(String, RtfExportOptions) Inherited from BaseView.
ExportToRtf(String) Exports the GridControl.DefaultView‘s data to a file in RTF format. Inherited from BaseView.
ExportToText(Stream, TextExportOptions) Exports the GridControl.DefaultView‘s data to the specified stream in Text format using the specified options. Inherited from BaseView.
ExportToText(Stream, String, Boolean, Encoding) Obsolete. Exports the GridControl.DefaultView‘s data to a stream in TXT format using the specified separator string, quotation and text encoding settings. Inherited from BaseView.
ExportToText(Stream, String, Boolean) Obsolete. Exports the GridControl.DefaultView‘s data to a stream in TXT format using the specified separator string and quotation settings. Inherited from BaseView.
ExportToText(Stream, String) Obsolete. Exports the GridControl.DefaultView‘s data to a stream in TXT format using the specified separator string. Inherited from BaseView.
ExportToText(Stream) Exports the GridControl.DefaultView‘s data to a stream in TXT format. Inherited from BaseView.
ExportToText(String, TextExportOptions) Exports the GridControl.DefaultView‘s data to the specified file in Text format using the specified options. Inherited from BaseView.
ExportToText(String, String, Boolean, Encoding) Obsolete. Exports the GridControl.DefaultView‘s data to a file in TXT format using the specified separator string, quotation and text encoding settings. Inherited from BaseView.
ExportToText(String, String, Boolean) Obsolete. Exports the GridControl.DefaultView‘s data to a file in TXT format using the specified separator string and quotation settings. Inherited from BaseView.
ExportToText(String, String) Obsolete. Exports the GridControl.DefaultView‘s data to a file in TXT format using the specified separator string. Inherited from BaseView.
ExportToText(String) Exports the GridControl.DefaultView‘s data to the specified file in TXT format. Inherited from BaseView.
ExportToTextOld(String) Obsolete. Exports the GridControl.DefaultView‘s data to the specified file in TXT format. Inherited from BaseView.
ExportToXls(Stream, XlsExportOptions) Exports the GridControl.DefaultView‘s data to the specified stream in XLS format using the specified options. Inherited from BaseView.
ExportToXls(Stream, Boolean) Obsolete. Exports the GridControl.DefaultView‘s data to a stream in XLS format with the specified formatting settings. Inherited from BaseView.
ExportToXls(Stream) Exports the GridControl.DefaultView‘s data to a stream in XLS format Inherited from BaseView.
ExportToXls(String, XlsExportOptions) Exports the GridControl.DefaultView‘s data to the specified file in XLS format using the specified options. Inherited from BaseView.
ExportToXls(String, Boolean) Obsolete. Exports the GridControl.DefaultView‘s data to a file in XLS format with the specified formatting settings. Inherited from BaseView.
ExportToXls(String) Exports the GridControl.DefaultView‘s data to a file in XLS format. Inherited from BaseView.
ExportToXlsx(Stream, XlsxExportOptions) Exports the GridControl.DefaultView‘s data to the specified stream in XLSX (MS Excel 2007) format using the specified options. Inherited from BaseView.
ExportToXlsx(Stream) Exports the GridControl.DefaultView‘s data to the specified stream in XLSX (MS Excel 2007) format. Inherited from BaseView.
ExportToXlsx(String, XlsxExportOptions) Exports the GridControl.DefaultView‘s data to the specified file in XLSX (MS Excel 2007) format using the specified options. Inherited from BaseView.
ExportToXlsx(String) Exports the GridControl.DefaultView‘s data to the specified file in XLSX (MS Excel 2007) format. Inherited from BaseView.
FindRow(Object) Searches for the target data row within this ColumnView.
Focus() Focuses the Grid Control and current View within it. Inherited from BaseView.
FocusInvalidRow() Moves focus to an invalid row.
GetColumnError(GridColumn) Gets the error description for a specific cell or the entire focused row.
GetColumnErrorType(GridColumn) Gets the type of the error associated with the specified cell in the currently focused row.
GetColumnHeaderBestWidth(GridColumn)
GetDataRow(Int32) Returns a DataRow object that represents the specified row.
GetDataSourceRowIndex(Int32) Returns the index of the data source record that corresponds to the specified row handle.
GetDisplayTextByColumnValue(GridColumn, Object) Formats a value according to the specified column’s format settings.
GetFilterDisplayText(CriteriaOperator) Returns the textual representation of the specified CriteriaOperator object.
GetFilterDisplayText(ViewFilter) Returns the textual representation of the specified filter.
GetFocusedDataRow() Returns a DataRow object that represents the focused row.
GetFocusedDataSourceRowIndex() Returns the index of the data source record that corresponds to the focused grid row (card).
GetFocusedDisplayText() Returns the focused cell’s display value.
GetFocusedRow() Returns an object representing the focused row.
GetFocusedRowCellDisplayText(GridColumn) Returns the text displayed in the specified column within the focused row.
GetFocusedRowCellDisplayText(String) Gets the display value of the specified cell in the focused row.
GetFocusedRowCellValue(GridColumn) Returns the specified column’s edit value within the focused row.
GetFocusedRowCellValue(String) Returns the edit value of the specified cell within the focused row.
GetFocusedValue() Returns the focused cell’s value.
GetHashCode() Serves as the default hash function. Inherited from Object.
GetIncrementalText() Returns the text being searched during an incremental search.
GetLifetimeService() Retrieves the current lifetime service object that controls the lifetime policy for this instance. Inherited from MarshalByRefObject.
GetListSourceRowCellValue(Int32, GridColumn) Returns the value of the specified cell, which is identified by a column and the index of a record in the data source.
GetListSourceRowCellValue(Int32, String) Returns the value of the specified cell, which is identified by a field name and the index of a record in the data source.
GetNearestCanFocusedColumn(GridColumn) Returns the nearest column to the specified one that can be focused.
GetNextVisibleRow(Int32) Returns the visible index of the row that follows a specific row.
GetPrevVisibleRow(Int32) Gets the visible index of the row that is located prior to the specified row.
GetRow(Int32) Returns an object that represents the row in a Grid data source.
GetRowCellDisplayText(Int32, GridColumn) Returns a specific cell’s display value from the current View.
GetRowCellDisplayText(Int32, String) Gets the display value of the specified cell.
GetRowCellValue(Int32, GridColumn) Returns a specific cell value from the current View.
GetRowCellValue(Int32, String) Gets the value of the specified cell in the grid’s data source.
GetRowHandle(Int32) Returns the handle of the row which represents the specified record in the data source.
GetSelectedRows() Returns the handles of the selected rows or cards. Multiple rows can be selected when the ColumnViewOptionsSelection.MultiSelect option is set to true.
GetService(Type) protected Returns an object that represents a service provided by the Component or by its Container. Inherited from Component.
GetShowEditorMode() Returns a value that specifies how an in-place editor is activated for a grid cell.
GetShowEditorMode(Int32) This member supports the internal infrastructure, and is not intended to be used directly from your code.
GetType() Gets the Type of the current instance. Inherited from Object.
GetViewCaption() Gets the View’s display caption. Inherited from BaseView.
GetViewInfo() Returns the object which contains the internal information used to render the View. Inherited from BaseView.
GetVisibleColumn(Int32) Returns the column displayed at a specific position.
GetVisibleIndex(Int32) Returns the visible index of the row specified by its handle.
GetVisibleRowHandle(Int32) Returns the handle of the row which is displayed at the specified position.
HideEditor() Closes the currently active inplace editor discarding changes made to the edited value.
HideFindPanel() Hides the Find Panel.
InitializeLifetimeService() Obtains a lifetime service object to control the lifetime policy for this instance. Inherited from MarshalByRefObject.
Invalidate() Invalidates the region occupied by the current View (adds it to the control’s update region that will be repainted during the next paint operation), and causes a paint message to be sent to the grid control. Inherited from BaseView.
InvalidateHitObject(BaseHitInfo) Invalidates the View element located at the point specified by the hit information object. Inherited from BaseView.
InvalidateRect(Rectangle) Invalidates the specified region of a View (adds it to the control’s update region, which will be repainted during the next paint operation), and causes a paint message to be sent to the grid control. Inherited from BaseView.
InvertRowSelection(Int32) Toggles the specified row’s selected state.
IsDataRow(Int32) Indicates whether the specified record is a regular data row/card.
IsNewItemRow(Int32) Indicates whether the specified row/card is the New Item Row/Card.
IsRowLoaded(Int32) Gets whether the specified row’s data has been loaded (in Instant Feedback Mode).
IsRowSelected(Int32) Indicates whether the specified row is selected.
IsValidRowHandle(Int32) Indicates whether the specified row handle is valid.
LayoutChanged() Updates the current View. Inherited from BaseView.
LoadRow(Int32) Loads a row in Instant Feedback Mode.
LoadRowHierarchy(Int32, OperationCompleted) Loads the specified data row’s parent group rows (if they are not already loaded) in Instant Feedback Mode.
LocateByDisplayText(Int32, GridColumn, String) Locates rows by cells’ display texts.
LocateByValue(Int32, GridColumn, Object, OperationCompleted[]) Locates rows by cell values.
LocateByValue(String, Object, OperationCompleted[]) Locates rows by cell values.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
MemberwiseClone(Boolean) protected Creates a shallow copy of the current MarshalByRefObject object. Inherited from MarshalByRefObject.
MoveBy(Int32) Moves row focus by the specified number of rows.
MoveFirst() Moves focus to the first row.
MoveLast() Moves focus to the last data record.
MoveLastVisible() Moves focus to the last visible row.
MoveNext() Moves focus to the row which is after the focused row.
MoveNextPage() Moves focus to the next page.
MovePrev() Moves focus to the previous row.
MovePrevPage() Moves focus to the previous page.
NormalView() Cancels View zooming.
PopulateColumns() Creates columns for all fields in the bound data source.
PopulateColumns(DataColumnInfo[]) Creates columns for the specified DataColumnInfo objects.
PopulateColumns(DataTable) Creates columns for all the fields of the specified DataTable.
PopulateColumns(Object) Creates columns for record fields in the specified data source (System.Data.DataTable, System.ComponentModel.ITypedList, System.Collections.IList, System.Collections.Generic.IList, DevExpress.XtraGrid.IXtraList, etc. ).
PopulateColumns(Type, PopulateColumnsParameters) Generates columns for the custom code-first data source.
PostEditor() Saves the modified cell value to the data source. If the GridOptionsView.RowAutoHeight setting is disabled, the currently active cell editor remains opened. Inherited from BaseView.
Print() Inherited from BaseView.
PrintDialog() Inherited from BaseView.
QueryMoreRows() Sends a request to a data source to load more records in virtual (event-based) server mode. Inherited from BaseView.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
RefreshData() Reloads data into View from the data source.
RefreshEditor(Boolean) Refreshes the active editor.
RefreshRow(Int32) Invalidates the specified row, and forces it to be redrawn.
ResetCursor() Sets the mouse cursor to the grid’s Cursor property value. Inherited from BaseView.
RestoreLayoutFromRegistry(String, OptionsLayoutBase) Restores the View’s layout using the specified settings stored at the specified system registry path. Inherited from BaseView.
RestoreLayoutFromRegistry(String) Restores a View’s layout stored at the specified system registry path. Inherited from BaseView.
RestoreLayoutFromStream(Stream, OptionsLayoutBase) Restores the View’s layout using the specified settings which are stored in the specified stream. Inherited from BaseView.
RestoreLayoutFromStream(Stream) Restores a View’s layout from the specified stream. Inherited from BaseView.
RestoreLayoutFromXml(String, OptionsLayoutBase) Restores the View’s layout using the specified settings from the specified XML file. Inherited from BaseView.
RestoreLayoutFromXml(String) Restores a View’s layout from a specific XML file. Inherited from BaseView.
SaveLayoutToRegistry(String, OptionsLayoutBase) Saves the View’s layout using the specified settings to the specified system registry path. Inherited from BaseView.
SaveLayoutToRegistry(String) Saves a View’s layout to a system registry path. Inherited from BaseView.
SaveLayoutToStream(Stream, OptionsLayoutBase) Saves the View’s layout using the specified settings to the specified stream. Inherited from BaseView.
SaveLayoutToStream(Stream) Saves a View’s layout to a specific stream. Inherited from BaseView.
SaveLayoutToXml(String, OptionsLayoutBase) Saves the View’s layout using the specified settings to the specified XML file. Inherited from BaseView.
SaveLayoutToXml(String) Saves a View’s layout to a specific XML file. Inherited from BaseView.
SelectAll() Selects all rows (cards) within the View, except rows residing within collapsed groups.
SelectRange(Int32, Int32) Selects the visible rows (cards) in the specified range.
SelectRow(Int32) Adds a row (card) to the current selection.
SetColumnError(GridColumn, String, ErrorType) Sets an error description and an error type for the specified cell within the focused row.
SetColumnError(GridColumn, String) Sets an error description for a cell within the focused row or for the entire focused row.
SetFocusedRowCellValue(GridColumn, Object) Assigns a value to the specified column within the currently focused row.
SetFocusedRowCellValue(String, Object) Assigns a value to the specified field within the currently focused row.
SetFocusedRowModified() Marks the focused row as modified.
SetFocusedValue(Object) Assigns a value to the focused cell.
SetRowCellValue(Int32, GridColumn, Object) Assigns a value to a specific cell.
SetRowCellValue(Int32, String, Object) Sets the value of the specified cell in the current View.
ShowCustomFilterDialog(GridColumn) Displays the custom filter dialog.
ShowEditor() Activates the focused cell’s editor. Inherited from BaseView.
ShowEditorByKey(KeyEventArgs) Activates an editor for the focused row cell and passes a specific key to it. Inherited from BaseView.
ShowEditorByKeyPress(KeyPressEventArgs) Activates an editor for the focused row cell and passes a specific key to it. Inherited from BaseView.
ShowEditorByMouse() Activates an editor for the focused row cell and passes a mouse click to it. Inherited from BaseView.
ShowFilterEditor(GridColumn) Displays the Filter Editor.
ShowFilterPopup(GridColumn) Displays a Filter DropDown for the specified column.
ShowFindPanel() Displays the Find Panel.
ShowPrintPreview() Inherited from BaseView.
ShowRibbonPrintPreview() Inherited from BaseView.
ShowUnboundExpressionEditor(GridColumn) Invokes an Expression Editor that enables editing an expression for the specified unbound column.
Synchronize(BaseView, SynchronizationMode) Copies the specified settings of a View to the current View. Inherited from BaseView.
Synchronize(BaseView) Copies the visual and data representation settings of a specific View to the current View. Inherited from BaseView.
SynchronizeData(BaseView) Synchronizes a View’s data representation settings with the specified View.
SynchronizeVisual(BaseView) Synchronizes a View’s visual settings with the specified View.
ToString() Returns a String containing the name of the Component, if any. This method should not be overridden. Inherited from Component.
UnselectRow(Int32) Removes a row (card) from the current selection.
UpdateCurrentRow() Validates the focused row and saves its values to the data source.
ValidateEditor() Validates the active editor.
ViewRowHandleToDataSourceIndex(Int32) Converts the specified row handle to a data source record index.
WaitForAsyncOperationEnd() This member supports the internal infrastructure and is not intended to be used directly from your code.
ZoomView() Maximizes the current detail View clone. Inherited from BaseView.
See Also