findText.wrap parameter

Use the findText.wrap parameter to set or query the wrap setting for the findText command.

 

Availability

query command
set command
current parameter
default parameter
install parameter

 

Scope

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

 

Syntax

query findText.wrap
set findText.wrap [ default | on | off ]
query current.findText.wrap
query default.findText.wrap
set default.findText.wrap [ install | on | off ]
query install.findText.wrap 

 

Parameters

default If you specify the default parameter for the set findText.wrap command, the current view will use the value of default.findText.wrap for the wrap setting for the findText command.
on If you specify the on parameter for the set findText.wrap command, the findText command will wrap around to the top (bottom) of the document when searching down (up) within the current view.  If you specify the on parameter for the set default.findText.wrap command, the findText command will wrap around to the top (bottom) of the document when searching down (up) within all of document views that have findText.wrap set to default.
off If you specify the off parameter for the set findText.wrap command, the findText command will not wrap around to the top (bottom) of the document when searching down (up) within the current view.  If you specify the off parameter for the set default.findText.wrap command, the findText command will not wrap around to the top (bottom) of the document when searching down (up) within all of document views that have findText.wrap set to default.
install If you specify the install parameter for the set default.findText.wrap command, all of the views that have findText.wrap set to default will use the value of install.findText.wrap to determine whether the findText command should wrap around to the top (bottom) of the document when searching down (up).

 

Description

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

The query current.findText.wrap command returns on if the findText command will wrap around to the top (bottom) of the document when searching down (up), and off if the findText command will not wrap when it reaches the top or bottom of the document.

 

Examples

query findText.wrap
set findText.wrap off
query current.findText.wrap
query default.findText.wrap
set default.findText.wrap on
query install.findText.wrap 

Related reference
findText command
query command
set command
current parameter
default parameter
findText.asis parameter
findText.block 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
install parameter