GridListEditor Class

Represents the List Editor used by default in XAF Windows Forms applications, to display List Views in a UI.

Namespace: DevExpress.ExpressApp.Win.Editors

Assembly: DevExpress.ExpressApp.Win.v18.1.dll

Syntax

public class GridListEditor :
    WinColumnsListEditor,
    IDisposable,
    IProtectedContentEditor,
    ISupportToolTip,
    IControlOrderProvider,
    IOrderProvider,
    IDXPopupMenuHolder,
    IComplexListEditor,
    IHtmlFormattingSupport,
    IFocusedElementCaptionProvider,
    ISupportAppearanceCustomization,
    ISupportEnabledCustomization,
    IExportable,
    ISupportFilter,
    ISupportUpdate,
    IGridViewOptions,
    IDataAwareExportableCsv,
    IDataAwareExportableXls,
    IDataAwareExportableXlsx,
    IDataAwareExportable,
    IInstantFeedbackSupport,
    ISupportNewItemRowPosition,
    ISupportFooter,
    ILookupListEditor,
    IGridListEditorTestable,
    ILookupEditProvider,
    IRequireContextMenu,
    IRequireDXMenuManager,
    IConfigurableLookupListEditor,
    ISupportBorderStyle

List Editors are used by List Views to display object collections in a UI. The GridListEditor provides the most common data representation in the form of a two-dimensional table:

WinGridListEditor

To display object collections, the GridListEditor uses an instance of the GridControl class as the underlying control.

The GridListEditor supports a wide range of features out of the box:

The GridListEditor is used by default in XAF Windows Forms applications. So generally, there is no need to instantiate it in your code. However, the GridListEditor exposes a range of useful public members that are not defined in the base ListEditor class. These members can be accessed, for example, from a custom Controller or Action. The following table lists them.

Property Name Member Type Description
WinColumnsListEditor.ColumnCreated Event Occurs after a column has been created in the GridListEditor's GridView. Handle this event to be notified after a column has been created or recreated in the GridListEditor's GridView.
WinColumnsListEditor.Grid Property Provides access to the GridListEditor's GridControl control.
GridListEditor.GridView Property Provides access to the GridControl's View that is used to represent data in two-dimensional grid form.
GridListEditor.ProcessSelectedItemBySingleClick Property Specifies whether a List View's record must be processed after a click or a double-click.
GridListEditor.TrackMousePosition Property When this property is set to true, moving the mouse within the GridListEditor's region changes the focus to the row that is under the mouse pointer.

To see examples on how to access the GridListEditor from a View Controller, refer to the following topics:

Inherited Members

See Also