findText.block Parameter

findText.block parameter

Use the findText.block parameter to set or query whether the findText command restricts its search to the selected text area.

Availability

query command
set command
current parameter
default parameter
install parameter

Scope

findText.block is scoped to the current view.
current.findText.block is scoped to the current view.
default.findText.block is globally scoped.
install.findText.block is globally scoped.

Syntax
query findText.block
set findText.block [ default | on | off ]
query current.findText.block
query default.findText.block
set default.findText.block [ install | on | off ]
query install.findText.block 
Parameters

default If you specify the default parameter for the set findText.block command, the current view will use the value of default.findText.block to decide whether the findText command should restrict its search to the selected text.
on If you specify the on parameter for the set findText.block command, the findText command will restrict its search to only the selected text within the current view. If you specify the on parameter for the set default.findText.block command, the findText command will restrict its search to the selected text within all of the document views that have findText.block set to default.
off If you specify the off parameter for the set findText.block command, the findText command will not restrict its search to the selected text within the current view. If you specify the off parameter for the set default.findText.block command, within all document views that have findText.block set to default, the findText command will not restrict its search to the selected text.
install If you specify the install parameter for the set default.findText.block command, all views with findText.block set to default will use the value of install.findText.block to determine whether the findText command should restrict its search to the selected text.

Description

If you do not specify any of the parameters for the set findText.block command, default is assumed. If you do not specify any of the parameters for the set default.findText.block command, install is assumed.

The query current.findText.block command returns on if, for the current view, the findText command is restricting its search to the selected text. The query current.findText.block command returns off if, for the current view, the findText command is not restricting its search to the selected text.

Examples
query findText.block
set findText.block off
query current.findText.block
query default.findText.block
set default.findText.block on
query install.findText.block 
findText command
query command
set command
current parameter
default parameter
findText.asis parameter
findText.columns parameter
findText.emphasis parameter
findText.endColumn parameter
findText.findText parameter
findText.mark parameter
findText.regularExpression parameter
findText.replaceText parameter
findText.startColumn parameter
findText.wholeWord parameter
findText.wrap parameter
install parameter

default	If you specify the default parameter for the set findText.block command, the current view will use the value of default.findText.block to decide whether the findText command should restrict its search to the selected text.
on	If you specify the on parameter for the set findText.block command, the findText command will restrict its search to only the selected text within the current view. If you specify the on parameter for the set default.findText.block command, the findText command will restrict its search to the selected text within all of the document views that have findText.block set to default.
off	If you specify the off parameter for the set findText.block command, the findText command will not restrict its search to the selected text within the current view. If you specify the off parameter for the set default.findText.block command, within all document views that have findText.block set to default, the findText command will not restrict its search to the selected text.
install	If you specify the install parameter for the set default.findText.block command, all views with findText.block set to default will use the value of install.findText.block to determine whether the findText command should restrict its search to the selected text.