OnValidationFailed event

Project: Shell Folders Unit.

Unit: PJShellFolders.

Class: TPJBrowseDialog

Applies to: ~>2.3

type
  TPJBrowseValidationFailedEvent = procedure(Sender: TObject;
    const EditText: string; var CanClose: Boolean) of object;

property OnValidationFailed: TPJBrowseValidationFailedEvent;

Description

OnValidationFailed is triggered whenever an invalid folder is entered in the browser dialog’s edit control and the user OKs. The event is only ever triggered if the Options property contains both the boNewDlgStyle and boEditBox options.

The event handler’s parameters are:

• Sender contains a reference to the dialog box component that triggers the event.
• EditText contains the erroneous text entered in the edit control.
• CanClose indicates whether the dialog box is permitted to close: it is true when the event is triggered but can be changed to False in the event handler to prevent the dialog box from closing.

Implement an event handler to take any required action, such as displaying an error message.