RepositoryItemPopupBase.CloseUp Event

Enables you to specify whether changes are saved or discarded when closing the popup window.

Namespace: DevExpress.XtraEditors.Repository

Assembly: DevExpress.XtraEditors.v20.1.dll

Declaration

[DXCategory("Events")]
public virtual event CloseUpEventHandler CloseUp
<DXCategory("Events")>
Public Overridable Event CloseUp As CloseUpEventHandler

Event Data

The CloseUp event's data class is CloseUpEventArgs. The following properties provide information specific to this event:

Property Description
AcceptValue Gets or sets a value indicating whether CloseUpEventArgs.Value should be accepted or discarded.
CloseMode Gets a value indicating how the popup editor's dropdown window was closed.
PressedButton Returns which popup button has been pressed by an end-user.
Value Gets or sets a value to assign to the editor's edit value.

Remarks

The CloseUp event fires when closing the popup window. The event's parameters allow you to change the value the user submitted and to specify whether to accept or discard the value.

Initially, the CloseUpEventArgs.AcceptValue parameter indicates whether the modifications performed within the popup window are about to be saved or discarded. The parameter's initial value is false in the following cases:

When closing the popup window using other methods, the CloseUpEventArgs.AcceptValue parameter value is initially true, and modifications are about to be accepted. If you need to override the default behavior, change the parameter value. If you need to modify the value before it is accepted, modify the CloseUpEventArgs.Value parameter.

Note: you can also handle the RepositoryItem.EditValueChanging event to control the values to be accepted by the editor.

The editor's PopupBaseEdit.CloseUp event is equivalent to the current event.

NOTE

When using popup editors within bars, do not invoke modal windows while handling the CloseUp event. Opening modal windows will cause data loss.

Examples

The following example shows how you can restrict user input in a date editor. The user is able to enter dates between January 1 and December 31 of the current year. Other dates are not acceptable. If the user selects a date less than January 1, the edit value will be set to January 1. If the selected date is greater than December 31, the edit value will be set to the maximum possible date.

For this purpose, we will use the editor's PopupBaseEdit.CloseUp event. Its handler is listed below.

Note that the user can enter the date in the edit box without activating the dropdown window. In this case, the PopupBaseEdit.CloseUp event is not fired, and therefore, no validation is performed. To prevent such situations, you can set the RepositoryItemButtonEdit.TextEditStyle property to TextEditStyles.DisableTextEditor. Another method is to handle the RepositoryItem.EditValueChanging event, to control edit value changes.

using DevExpress.XtraEditors.Controls;
private void dateEdit1_CloseUp(object sender, CloseUpEventArgs e) {
    DateTime selectedDate = (DateTime)e.Value;
    int currentYear = DateTime.Today.Year;
    if (selectedDate.Year < currentYear)
      e.Value = new DateTime(currentYear, 1, 1);
    else
      if (selectedDate.Year > currentYear)
        e.Value = new DateTime(currentYear, 12, 31);      
}
See Also