[Overview][Constants][Types][Classes][Procedures and functions][Variables][Index] | Reference for unit 'Dialogs' (#lcl)

# TFindDialog

[Properties (by Name)] [Methods (by Name)] [Events (by Name)]

TFindDialog - a dialog used for finding text within the current editor or text buffer.

## Declaration

Source position: dialogs.pp line 454

`type TFindDialog = class(TCommonDialog)`
`protected`
`FFindForm: TForm;` |  | FFindForm - local variable holding the form used for the Find dialog.
`FOnReplace: TNotifyEvent;` |  | FOnReplace - local variable identifying the event handler for replacing.
`FOnFind: TNotifyEvent;` |  | FOnFind - local variable identifying the event handler for finding.
`FOptions: TFindOptions;` |  | FOptions - local variable holding the set of current options.
`FOnHelpClicked: TNotifyEvent;` |  | FOnHelpClicked - local variable identifying the help event handler.
`FReplaceText: string;` |  | FReplaceText - local variable holding the Replace text.
`FFindText: string;` |  | FFindText - local variable containing the text to be found.
`function DefaultTitle; override;` |  | Returns the default title displayed on the dialog.
`procedure FindClick();` |  | Implements the OnClick event handler for the Find button on the dialog.
`procedure HelpClick();` |  | Implements the OnClick event handler for the Help button on the dialog.
`procedure CancelClick();` |  | Implements the OnClick event handler for the Cancel button on the dialog.
`function GetHeight; override;` |  | Get the value for the Height property.
`function GetWidth; override;` |  | Gets the value for the Width property.
`procedure DoCloseForm(); virtual;` |  | Implements the OnClose event handler on the internal form displayed for the dialog.
`procedure DoShowForm(); virtual;` |  | Implements the OnShow event handler on the internal form displayed for the dialog.
`procedure Find; virtual;` |  | Signals the OnFind event handler when the Find button is clicked on the dialog form.
`procedure Help; virtual;` |  | Signals the OnHelpClicked event handler when the Help button on the dialog form is clicked.
`procedure Replace; virtual;` |  | Signals the OnReplace event handler when the Replace button is clicked on the dialog form.
`function CreateForm; virtual;` |  | Creates and configures the internal form displayed for the dialog.
`procedure SetFormValues; virtual;` |  | Stores property values in the class instance to the controls on the dialog form.
`procedure GetFormValues; virtual;` |  | Retrieves values from the dialog form and stores them in the properties for the class instance.
`procedure CalcPosition();` |  | Determines the position for the dialog form and captures its coordinates.
`property ReplaceText: string; [rw]` |  | String with the value used to replace the value in FindText.
`property OnReplace: TNotifyEvent; [rw]` |  | Event handler signalled to replace occurrence(s) of FindText with the value in ReplaceText.
`public`
`constructor Create(); override;` |  | Constructor for the class instance.
`destructor Destroy; override;` |  | Destructor for the class instance.
`procedure CloseDialog;` |  | Closes the dialog form when its Cancel button is clicked.
`function Execute; override;` |  | Displays the dialog form and responds to button clicks.
`property Left: Integer; [rw]` |  | Coordinate for the Left side of the dialog form.
`property Position: TPoint; [rw]` |  | The position for the dialog form.
`property Top: Integer; [rw]` |  | Coordinate for the Top edge of the dialog form.
`published`
`property FindText: string; [rw]` |  | Contains the text to locate when the Find button is clicked on the dialog form.
`property Options: TFindOptions; [rw]` |  | Contains the find / replace options enabled for the dialog.
`property OnFind: TNotifyEvent; [rw]` |  | Event handler signalled when the Find button is clicked on the dialog form.
`property OnHelpClicked: TNotifyEvent; [rw]` |  | Event handler signalled when the Help button is clicked on the dialog form.
`end;`

## Inheritance

`TFindDialog` |  | TFindDialog - a dialog used for finding text within the current editor or text buffer.
`TCommonDialog` |  | The base type from which other dialogs are derived.
`TLCLComponent` |  | The base class for LCL components which have an associated widget.
`TComponent`
?
`TObject`

## Description

Opens a dialog box allowing the user to enter text for searching, for example in a text editor.

As TFindDialog is the parent class for the TReplaceDialog, it contains definitions for the Replace method, but the Replace option does not actually appear when the dialog is displayed: you need to use TReplaceDialog to do that.

## See also

TReplaceDialog |  | Implements a find and replace dialog.