findText.columns Parameter

findText.columns parameter

Use the findText.columns parameter to set or query whether the findText command restricts its search to selected columns indicated by current.findText.startColumn and current.findText.endColumn.

Availability

query command
set command
current parameter
default parameter
install parameter

Scope

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

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

default If you specify the default parameter for the set findText.columns command, the current view will use the value of default.findText.columns for the columns setting for the findText command.
on If you specify the on parameter for the set findText.columns command, the findText command will restrict its search to the columns indicated by current.findText.startColumn and current.findText.endColumn within the current view. If you specify the on parameter for the set default.findText.columns command, the findText command will restrict its search to the columns indicated by current.findText.startColumn and current.findText.endColumn within all document views that have findText.columns set to default.
off If you specify the off parameter for the set findText.columns command, the findText command will not restrict its search to the columns indicated by current.findText.startColumn and current.findText.endColumn within the current view. If you specify the off parameter for the set default.findText.columns command, the findText command will not restrict its search to the columns indicated by current.findText.startColumn and current.findText.endColumn within all of the document views that have findText.columns set to default.
install If you specify the install parameter for the set default.findText.columns command, all views with findText.columns set to default will use the value of install.findText.columns to determine whether the findText command should restrict its search to the columns indicated by current.findText.startColumn and current.findText.endColumn.

Description

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

The query current.findText.columns command returns on if the findText command is restricting its search to the text found between the columns indicated by current.findText.startColumn and current.findText.endColumn. The query current.findText.columns command returns off if the findText command is not restricting its search to the text found between the columns indicated by current.findText.startColumn and current.findText.endColumn.

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

default	If you specify the default parameter for the set findText.columns command, the current view will use the value of default.findText.columns for the columns setting for the findText command.
on	If you specify the on parameter for the set findText.columns command, the findText command will restrict its search to the columns indicated by current.findText.startColumn and current.findText.endColumn within the current view. If you specify the on parameter for the set default.findText.columns command, the findText command will restrict its search to the columns indicated by current.findText.startColumn and current.findText.endColumn within all document views that have findText.columns set to default.
off	If you specify the off parameter for the set findText.columns command, the findText command will not restrict its search to the columns indicated by current.findText.startColumn and current.findText.endColumn within the current view. If you specify the off parameter for the set default.findText.columns command, the findText command will not restrict its search to the columns indicated by current.findText.startColumn and current.findText.endColumn within all of the document views that have findText.columns set to default.
install	If you specify the install parameter for the set default.findText.columns command, all views with findText.columns set to default will use the value of install.findText.columns to determine whether the findText command should restrict its search to the columns indicated by current.findText.startColumn and current.findText.endColumn.