compare.columns Parameter

compare.columns parameter

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

Availability

query command
set command
current parameter
default parameter
install parameter

Scope

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

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

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

Description

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

The query current.compare.columns command returns on if the compare command is restricting its comparison to the text found between the columns indicated by current.compare.startColumn and current.compare.endColumn. The query current.compare.columns command returns off if the compare command is not restricting its comparison to a column range.

Examples
query compare.columns
set compare.columns off
query current.compare.columns
query default.compare.columns
set default.compare.columns on
query install.compare.columns 
compare command
query command
set command
compare.endColumn parameter
compare.ignoreAllBlanks parameter
compare.ignoreCase parameter
compare.ignoreComments parameter
compare.ignoreLeadingBlanks parameter
compare.ignoreSequenceNumbers parameter
compare.ignoreTrailingBlanks parameter
compare.startColumn parameter
current parameter
default parameter
install parameter

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