findText.wholeWord Parameter

findText.wholeWord parameter

Use the findText.wholeWord parameter to set or query whether the findText command restricts its search to whole words. Words consist of letters, digits, and underscores.

Availability

query command
set command
current parameter
default parameter
install parameter

Scope

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

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

default If you specify the default parameter for the set findText.wholeWord command, the current view will use the value of default.findText.wholeWord to determine whether the findText command restricts its search to whole words.
on If you specify the on parameter for the set findText.wholeWord command, the findText command will restrict its search to whole words in the current view. If you specify the on parameter for the set default.findText.wholeWord command, the findText command will restrict its search to whole words in all of the document views that have findText.wholeWord set to default.
off If you specify the off parameter for the set findText.wholeWord command, the findText command will not restrict its search to whole words within the current view. If you specify the off parameter for the set default.findText.wholeWord command, within all document views that have findText.wholeWord set to default, the findText command will not restrict its search to whole words.
install If you specify the install parameter for the set default.findText.wholeWord command, all views with findText.wholeWord set to default will use the value of install.findText.wholeWord to determine whether the findText command should restrict its search to whole words.

Description

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

The query current.findText.wholeWord command returns on if, for the current view, the findText command is restricting its search to whole words. The query current.findText.wholeWord command returns off if, for the current view, the findText command is not restricting its search to whole words.

Examples
query findText.wholeWord
set findText.wholeWord off
query current.findText.wholeWord
query default.findText.wholeWord
set default.findText.wholeWord on
query install.findText.wholeWord 
findText command
query command
set command
current parameter
default parameter
install 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.wrap parameter

default	If you specify the default parameter for the set findText.wholeWord command, the current view will use the value of default.findText.wholeWord to determine whether the findText command restricts its search to whole words.
on	If you specify the on parameter for the set findText.wholeWord command, the findText command will restrict its search to whole words in the current view. If you specify the on parameter for the set default.findText.wholeWord command, the findText command will restrict its search to whole words in all of the document views that have findText.wholeWord set to default.
off	If you specify the off parameter for the set findText.wholeWord command, the findText command will not restrict its search to whole words within the current view. If you specify the off parameter for the set default.findText.wholeWord command, within all document views that have findText.wholeWord set to default, the findText command will not restrict its search to whole words.
install	If you specify the install parameter for the set default.findText.wholeWord command, all views with findText.wholeWord set to default will use the value of install.findText.wholeWord to determine whether the findText command should restrict its search to whole words.