TFindDialog class

In unit Dialogs

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

Declaration

pascal

TFindDialog = class(TCommonDialog)

Inheritance

TFindDialog
TCommonDialog
TLCLComponent
TComponent

Descends from it: TReplaceDialog

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.

Properties

`ReplaceText`	protected	String with the value used to replace the value in FindText.
`Left`	public	Coordinate for the Left side of the dialog form.
`Position`	public	The position for the dialog form.
`Top`	public	Coordinate for the Top edge of the dialog form.
`FindText`	published	Contains the text to locate when the Find button is clicked on the dialog form.
`Options`	published	Contains the find / replace options enabled for the dialog.

Methods

`DefaultTitle`	protected	Returns the default title displayed on the dialog.
`FindClick`	protected	Implements the OnClick event handler for the Find button on the dialog.
`HelpClick`	protected	Implements the OnClick event handler for the Help button on the dialog.
`CancelClick`	protected	Implements the OnClick event handler for the Cancel button on the dialog.
`GetHeight`	protected	Get the value for the Height property.
`GetWidth`	protected	Gets the value for the Width property.
`DoCloseForm`	protected	Implements the OnClose event handler on the internal form displayed for the dialog.
`DoShowForm`	protected	Implements the OnShow event handler on the internal form displayed for the dialog.
`Find`	protected	Signals the OnFind event handler when the Find button is clicked on the dialog form.
`Help`	protected	Signals the OnHelpClicked event handler when the Help button on the dialog form is clicked.
`Replace`	protected	Signals the OnReplace event handler when the Replace button is clicked on the dialog form.
`CreateForm`	protected	Creates and configures the internal form displayed for the dialog.
`SetFormValues`	protected	Stores property values in the class instance to the controls on the dialog form.
`GetFormValues`	protected	Retrieves values from the dialog form and stores them in the properties for the class instance.
`CalcPosition`	protected	Determines the position for the dialog form and captures its coordinates.
`Create`	public	Constructor for the class instance.
`Destroy`	public	Destructor for the class instance.
`CloseDialog`	public	Closes the dialog form when its Cancel button is clicked.
`Execute`	public	Displays the dialog form and responds to button clicks.

Events

`OnReplace`	protected	Event handler signalled to replace occurrence(s) of FindText with the value in ReplaceText.
`OnFind`	published	Event handler signalled when the Find button is clicked on the dialog form.
`OnHelpClicked`	published	Event handler signalled when the Help button is clicked on the dialog form.

Fields

`FFindForm`	protected	FFindForm - local variable holding the form used for the Find dialog.
`FOnReplace`	protected	FOnReplace - local variable identifying the event handler for replacing.
`FOnFind`	protected	FOnFind - local variable identifying the event handler for finding.
`FOptions`	protected	FOptions - local variable holding the set of current options.
`FOnHelpClicked`	protected	FOnHelpClicked - local variable identifying the help event handler.
`FReplaceText`	protected	FReplaceText - local variable holding the Replace text.
`FFindText`	protected	FFindText - local variable containing the text to be found.

Inherited

From TCommonDialog (21)

AttachTo Close DoCanClose DoClose DoExecute DoShow Handle HandleAllocated Height HelpContext OnCanClose OnClose OnDialogResult OnShow ResetShowCloseFlags SetHeight SetWidth Title UserChoice Width WSRegisterClass

From TLCLComponent (7)

DecLCLRefCount GetWSComponentClass IncLCLRefCount LCLRefCount NewInstance RemoveAllHandlersOfObject WidgetSetClass

An experiment, built from Lazarus main 2dfa93c66e of 10-22-2026. Not the official Lazarus documentation.