userParameter Parameter

userParameter parameter

userParameter is a convenience parameter for programmers of editor extensions. It allows you to associate various settings with the editor, at different scope levels, in a manner similar to the editor parameters.

Availability

query command
set command

Scope

userParameter.view. is scoped to the current view.
userParameter.document. is scoped to the current view's document.
userParameter is globally scoped.

Syntax
query userParameter.[ view. | document. ] name
set userParameter.[ view. | document. ] name [ value ] 
Parameters

view. Use the view. qualifier to specify the current view as the scope of the user parameter.
document. Use the document. qualifier to specify the current view's document as the scope of the user parameter.
name Use the name parameter to specify the name of the user parameter.
value Use the value parameter to specify the value of the user parameter. There are no restrictions on value. If you do not specify a value for the set userParameter command, the user parameter setting at the specified view, document, or global scope is removed; the higher-scope value of this user parameter, if any, is restored.

Description

Globally scoped user parameter settings are stored in the editor defaults profile (see the defaultProfile editor parameter). Document scoped user parameter settings, which override the global settings for a particular document, are stored in the associated document. View scoped user parameter settings, which override the document settings for a particular document view, are stored in the associated view.

The query userParameter command returns the setting of the user parameter at the specified scope if available, otherwise it returns the higher scope setting.

Examples
query userParameter.myParameter
query userParameter.document.myParameter
query userParameter.view.myParameter
set userParameter.myParameter Global setting
set userParameter.document.myParameter Document value
set userParameter.view.myParameter 42
set userParameter.myParameter 
query command
set command
defaultProfile parameter

view.	Use the view. qualifier to specify the current view as the scope of the user parameter.
document.	Use the document. qualifier to specify the current view's document as the scope of the user parameter.
name	Use the name parameter to specify the name of the user parameter.
value	Use the value parameter to specify the value of the user parameter. There are no restrictions on value. If you do not specify a value for the set userParameter command, the user parameter setting at the specified view, document, or global scope is removed; the higher-scope value of this user parameter, if any, is restored.