ColumnView.RefreshEditor(Boolean) Method

Refreshes the active editor.

Namespace: DevExpress.XtraGrid.Views.Base

Assembly: DevExpress.XtraGrid.v20.1.dll

Declaration

public virtual void RefreshEditor(
    bool updateEditorValue
)
Public Overridable Sub RefreshEditor(
    updateEditorValue As Boolean
)

Parameters

Name Type Description
updateEditorValue Boolean

true if the editor should update the value it displays; otherwise, false.

Remarks

There may be situations when a View's data source is modified externally. For instance, this may take place if there are several users working with the same database. In this case, modifying data source values will not automatically update the value displayed by the active editor. To synchronize the active editor's value with the data source, call the RefreshEditor method with its parameter set to true. If the parameter is false, the RefreshEditor method only updates the editor's appearance with respect to the editor's style settings and error information. The editor's value is not reread from the data source in this case.

If there is no active editor, the RefreshEditor method performs no actions.

NOTE

Detail pattern Views do not contain data and they are never displayed within XtraGrid. So, the RefreshEditor member must not be invoked for these Views. The RefreshEditor member can only be used with real Views that are displayed within the Grid Control. The real Views with which an end-user interacts at runtime can be accessed using the following methods.

See Also