Sign in Join
FPDoc Onlineexperiment

TFindDialog.Options property

Member of TFindDialogpublishedIn unit Dialogs

Contains the find / replace options enabled for the dialog.

Declaration

pascal
property Options: TFindOptions read FOptions write SetOptions default [frDown];

Description

Options is a TFindOptions property which contains the set of find / replace options enabled for the dialog. The set type contains zero (0) or more values from the TFindOption enumeration. The default value for the property is [frDown] and indicates the search direction in the dialog.

Changing the values in the property causes the controls on the dialog form to be updated (when assigned). For example:

frEntireScope
Causes the EntireScope check box to become checked.
frWholeWord
Causes the WholeWordsOnly check box to become checked.
frMatchCase
Causes the CaseSensitive check box to become checked.

Other values in Options control whether controls on the dialog form are visible or enabled, and are applied when the SetFormValues method is called. These include:

frDown
Causes the DirectionRadioGroup box to be set to the Down radio button.
frDisableWholeWord
Causes the WholeWordsOnly check box to be disabled (Enabled = False) when present.
frDisableMatchCase
Causes the CaseSensitive check box to be disabled (Enabled = False) when present.
frDisableUpDown
Causes the Direction radio group be disabled (Enabled = False) when present.
frHideWholeWord
Causes the WholeWordsOnly check box be hidden (Visible = False) when present.
frHideMatchCase
Causes the CaseSensitive check box be hidden (Visible = False) when present.
frHideUpDown
Causes the Direction radio group to be hidden (Visible = False) when present.
frShowHelp
Causes the Help button to be displayed (Visible = True) when present.
frHideEntireScope
Causes the EntireScope check box to be hidden (Visible = False) when present.

Values in Options are updated in the GetFormValues method, which is called when the Find button is clicked on the dialog form. The Option values affected include:

frDown
Added or removed based the radio button select in the Direction radio group.
frWholeWord
Added or removed based on the checked state for the WholeWordsOnly check box.
frMatchCase
Added or removed based on the checked state for the CaseSensitive check box.
frEntireScope
Added or removed based on the checked state for the EntireScope check box.

See also

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.