Skip to main content
.NET 6.0+

GridListEditor Members

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

Constructors

Name Description
GridListEditor(IModelListView) Creates and initializes an instance of the GridListEditor class.

Fields

Name Description
DefaultCanShowReadOnlyEditor static
DefaultNewItemRowHandlingMode static Specifies the default value of the GridListEditor.NewItemRowHandlingMode property.
DragDropCustomCodeId static This member is intended for internal use. Inherited from WinColumnsListEditor.
DragEnterCustomCodeId static This member is intended for internal use. Inherited from WinColumnsListEditor.
ImmediatePostDataSupportEnabled static
PageRowCountForServerMode static Specifies the number of records that are cached to allow the use of records navigation actions (Previous Record/Next Record) in Detail View when the underlying server-mode List View is already closed. Inherited from WinColumnsListEditor.
RestoreSelectedRowByHandle static This field is intended for internal use. Inherited from WinColumnsListEditor.

Properties

Name Description
AllowEdit Indicates whether the data bound to the current List Editor can be edited via the List Editor’s control. Inherited from ListEditor.
AppearanceFocusedCellMode Specifies whether the appearance settings for the focused cell are enabled.
BorderStyle Gets or sets the border style for the target Data Grid.
CanManageActiveFilterCriteriaPropertyValue For internal use. Inherited from WinColumnsListEditor.
CanManageFilterPropertyValue Obsolete. For internal use. Inherited from WinColumnsListEditor.
CanShowReadOnlyEditor
Columns Provides access to a collection of objects representing the WinColumnsListEditor‘s columns. Inherited from WinColumnsListEditor.
ColumnView Provides access to the View that is used to display data in the WinColumnsListEditor. Inherited from WinColumnsListEditor.
ContextMenuTemplate Provides access to the WinColumnsListEditor‘s Context Menu Template. Inherited from WinColumnsListEditor.
Control Provides access to the control that is used by the current List Editor to represent a List View in a UI. Inherited from ListEditor.
DataSource Specifies a List Editor‘s data source. Inherited from ListEditor.
ErrorMessages Provides access to the current ListEditor‘s error message collection, populated when Validation Rules are broken. Inherited from ListEditor.
Filter For internal use. Inherited from WinColumnsListEditor.
FilterColumnsMode Specifies whether only properties represented by the List Editor’s columns, or all properties, including the properties of the reference properties, are available in the Filter Editor for creating a filter criteria. Inherited from WinColumnsListEditor.
FocusedColumnMemberName Returns the name of a focused column field. Inherited from WinColumnsListEditor.
FocusedObject Gets or sets the focused object in a WinColumnsListEditor. Inherited from WinColumnsListEditor.
Grid Provides access to the grid control. Inherited from WinColumnsListEditor.
GridView Provides access to the Grid Control’s View that is used to display data in the GridListEditor.
GridViewSummaryModelSynchronizer
IsDisposed Indicates whether a List Editor has been disposed of. Inherited from ListEditor.
List This property is intended for internal use. Inherited from ListEditor.
LookupColumnFilterMode Specifies how the Automatic Filtering Row is displayed and how Find Panel performs a search in Server mode (see CollectionSourceBase.DataAccessMode) for lookup columns. Inherited from WinColumnsListEditor.
Model Provides access to the Application Model node that defines the List View represented by the current List Editors. Inherited from ListEditor.
Name Specifies the WinColumnsListEditor‘s name. Inherited from WinColumnsListEditor.
NewItemRowHandlingMode Specifies how a new object is created using the New Item Row.
NewItemRowPosition Gets or sets the position of the new item row within the GridListEditor.
PopupSite Gets the control over which a context menu is being invoked. Inherited from WinColumnsListEditor.
PreventServerSideOperationsForNonPersistentMembers Specifies whether server-side operations are prevented for non-persistent properties in the Server, ServerView, InstantFeedback, and InstantFeedbackView data access modes, or not. Inherited from ColumnsListEditor.
Printable Gets the control to be exported via the ExportController.ExportAction. Inherited from WinColumnsListEditor.
ProcessSelectedItemByDoubleClick Specifies whether or not the GridListEditor overrides the double click event processing (see ListViewProcessCurrentObjectController.ProcessCurrentObjectAction).
ProcessSelectedItemByEnter Specifies whether or not a selected item is processed by an Enter key press. Inherited from WinColumnsListEditor.
ProcessSelectedItemBySingleClick Specifies whether a List View’s record must be processed after a click or a double-click.
ProtectedContentText Specifies the text that is used by a List Editor to display a property which is prohibited for viewing by the current user. Inherited from ListEditor.
ReadOnlyEditors Specifies whether read-only editors with enabled in-place editing are used by the WinColumnsListEditor. Inherited from WinColumnsListEditor.
RepositoryFactory Provides access to the Repository Item Factory that is used by the WinColumnsListEditor to create in-place editors. Inherited from WinColumnsListEditor.
RequiredProperties Returns an array of descriptors for the properties considered bindable by the WinColumnsListEditor‘s Collection Source. Inherited from WinColumnsListEditor.
ScrollOnMouseMove Obsolete. For internal use.
SelectionType Returns the selection type supported by the WinColumnsListEditor. Inherited from WinColumnsListEditor.
SupportedExportFormats Provides access to the list of export formats supported by the current Grid List Editor. Inherited from WinColumnsListEditor.
TrackMousePosition Specifies whether mouse tracking is enabled for the GridListEditor.
UseAsyncLoading Specifies whether an XPO-based WinForms application loads a List View’s data asynchronously. Inherited from ListEditor.

Methods

Name Description
AddColumn(IModelColumn) Adds a column to the ColumnsListEditor, using information from the specified Application Model‘s node. Inherited from ColumnsListEditor.
ApplyModel() Updates the current List Editor’s state in accordance with the information stored in the Application Model.
BeginUpdate() Prevents the WinColumnsListEditor‘s control from being updated until the WinColumnsListEditor.EndUpdate method is called. Inherited from WinColumnsListEditor.
BreakLinksToControls() Removes references to the GridListEditor‘s control and its event handlers.
CanShowPopupMenu(Point) Returns a Boolean value that indicates whether it is possible to invoke a context menu at the specified position.
CreateControls() Creates the current List Editor‘s control that represents a List View in a UI. Inherited from ListEditor.
Dispose() Releases all resources used by the GridListEditor.
EndUpdate() Unlocks the WinColumnsListEditor‘s control after a call to the WinColumnsListEditor.BeginUpdate method and causes an immediate update. Inherited from WinColumnsListEditor.
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.
FindColumn(String) Provides access to the ColumnsListEditor‘s column with the specified identifier. Inherited from ColumnsListEditor.
FindColumnPropertyName(GridColumn) Returns the name of the property corresponding to the WinColumnsListEditor‘s specific GridListEditor.GridView column. Inherited from WinColumnsListEditor.
GetHashCode() Serves as the default hash function. Inherited from Object.
GetIndexByObject(Object) Returns the index of an object that represents a WinColumnsListEditor.ColumnView‘s row. Inherited from WinColumnsListEditor.
GetObjectByIndex(Int32) Returns an object that represents the WinColumnsListEditor.ColumnView‘s row with the specified index. Inherited from WinColumnsListEditor.
GetOrderedObjects() Returns an ordered list of objects that represent the WinColumnsListEditor.ColumnView‘s rows. Inherited from WinColumnsListEditor.
GetSelectedObjects() Provides access to the collection of objects that are currently selected in the WinColumnsListEditor‘s grid. Inherited from WinColumnsListEditor.
GetType() Gets the Type of the current instance. Inherited from Object.
GetVisibleColumns() Returns the list of ColumnsListEditor‘s visible columns. Inherited from ColumnsListEditor.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
OnExporting() Performs the required pre-export actions under the WinColumnsListEditor. Inherited from WinColumnsListEditor.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
Refresh() Refreshes the bound data source of the WinColumnsListEditor‘s control. Inherited from WinColumnsListEditor.
RemoveColumn(ColumnWrapper) Removes a particular column from the WinColumnsListEditor‘s WinColumnsListEditor.ColumnView. Inherited from WinColumnsListEditor.
RemoveColumn(GridColumn, IModelSynchronizersHolder) Removes a particular column from the WinColumnsListEditor‘s GridListEditor.GridView. Inherited from WinColumnsListEditor.
SaveModel() Saves the runtime customizations made by a user within the grid control to the Application Model differences.
SetHtmlFormattingEnabled(Boolean) Enables or disables HTML Formatting of the WinColumnsListEditor‘s column captions. Inherited from WinColumnsListEditor.
SetMenuManager(IDXMenuManager) Sets the IDXMenuManager object that controls the Look & Feel options of the Context Menu Template via the WinColumnsListEditor‘s control. Inherited from WinColumnsListEditor.
Setup(CollectionSourceBase, XafApplication) Performs additional initialization of the WinColumnsListEditor. Inherited from WinColumnsListEditor.
StartIncrementalSearch(String) Starts an incremental search for the specified string.
SupportsDataAccessMode(CollectionSourceDataAccessMode) Determines whether or not the given data access mode is supported by the ListEditor. Inherited from ListEditor.
ToString() Returns a string that represents the current object. Inherited from Object.

Events

Name Description
AllowEditChanged Occurs after the ListEditor‘s ListEditor.AllowEdit property has changed. Inherited from ListEditor.
BeginCustomization Occurs after the customization form that displays headers of hidden columns has been displayed.
ColumnAdded Occurs when a column is added to ColumnsListEditor. Inherited from ColumnsListEditor.
ColumnCreated Occurs after a column has been created in the WinColumnsListEditor‘s WinColumnsListEditor.Grid. Inherited from WinColumnsListEditor.
ControlDataSourceChanged For internal use. Inherited from WinColumnsListEditor.
ControlsCreated Occurs after a ListEditor‘s control is created. Inherited from ListEditor.
CreateCustomColumn For internal use. Inherited from WinColumnsListEditor.
CreateCustomFilterEditorRepositoryItem Occurs when creating a Filter Editor for the current Grid List Editor.
CreateCustomGridBand For internal use. Inherited from WinColumnsListEditor.
CreateCustomRepositoryItem For internal use. Inherited from WinColumnsListEditor.
CustomizeAppearance Occurs before the GridListEditor.GridView‘s cell of the WinColumnsListEditor has been repainted in a UI. Enables the appearance settings of individual cells to be changed. Inherited from WinColumnsListEditor.
CustomizeEnabled For internal use. Inherited from WinColumnsListEditor.
CustomizeFilterTreeNodeModelPropertyCaption Occurs when a filter visual presentation is formed.
CustomizeGridColumn Occurs when a column is created. Inherited from WinColumnsListEditor.
CustomizeRepositoryItem For internal use. Inherited from WinColumnsListEditor.
DataSourceChanged Occurs after the ListEditor.DataSource property’s value has been changed. Inherited from ListEditor.
EndCustomization Occurs before the customization form that displays headers of hidden columns has been closed.
FilterChanged For internal use. Inherited from WinColumnsListEditor.
FilterEditorCreated
FocusedObjectChanged Occurs after the focused object has been changed in a List Editor‘s control. Inherited from ListEditor.
FocusedObjectChanging Occurs before the focused object is changed in a List Editor‘s control. Inherited from ListEditor.
GetColumnError Occurs when the validation error occurs within the editable column.
GridDataSourceChanging For internal use. Inherited from WinColumnsListEditor.
ModelApplied Occurs after the customizations from the Application Model have been applied to the List Editor’s control. Inherited from ListEditor.
ModelApplying Occurs when customizations from the Application Model are applied to the List Editor’s control. Inherited from ListEditor.
ModelSaved Occurs after the List Editor’s control customizations have been saved to the Application Model. Inherited from ListEditor.
ModelSaving Occurs when the List Editor’s control customizations are saved to the Application Model. Inherited from ListEditor.
NewObjectAdding Occurs before a new object is created in a List Editor. Inherited from ListEditor.
NewObjectCanceled Occurs after creation of a new object is cancelled in a List Editor. Inherited from ListEditor.
NewObjectCreated Occurs after a new object has been created in a List Editor. Inherited from ListEditor.
ObjectChanged For internal use only. Inherited from ListEditor.
PrintableChanged Occurs when the IExportable.Printable control is created and disposed of. Inherited from WinColumnsListEditor.
ProcessSelectedItem Occurs after an object is selected in the List Editor‘s control and an end-user presses Enter or double-clicks the object. Inherited from ListEditor.
QueryCustomFunctions
RequiredPropertiesChanged Inherited from ListEditor.
SelectionChanged Occurs after the selection has been changed in a List Editor‘s control. Inherited from ListEditor.
SelectionTypeChanged Occurs after a List Editor‘s supported selection type is changed. Inherited from ListEditor.
ShowingReadOnlyEditor
ValidateObject Occurs when the object represented by the ListEditor‘s focused row must be validated. Inherited from ListEditor.
See Also