Parámetro userParameter

userParameter es un parámetro práctico para programadores de extensiones del editor.   Permite asociar varios valores al editor en distintos niveles de una forma similar a los parámetros del editor.

Disponibilidad

Mandato query
Mandato set

Ámbito

El ámbito de userParameter.view. es la vista actual.
El ámbito de userParameter.document. es el documento de la vista actual.
El ámbito de userParameter es global.

Sintaxis:

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

Parámetros

view. Utilice el calificador view. para especificar la vista actual como el ámbito del parámetro de usuario.
document. Utilice el calificador document. para especificar el documento de la vista actual como el ámbito del parámetro de usuario.
name Utilice el parámetro name para especificar el nombre del parámetro de usuario.
value Utilice el parámetro value para especificar el valor del parámetro de usuario.  No hay restricciones para value.  Si no especifica un valor para el mandato set userParameter, se elimina el valor del parámetro de usuario en el ámbito de vista, documento o global especificado; se restaura el valor de ámbito superior de este parámetro de usuario, si lo hay.

Descripción

Los valores de parámetro de usuario de ámbito global se almacenan en el perfil de valores predeterminados editor (consulte el parámetro del editor defaultProfile).  Los valores de parámetro de usuario de ámbito de documento que alteran temporalmente los valores globales para un documento determinado se almacenan en el documento asociado.  Los valores de parámetro de usuario de ámbito de vista que alteran temporalmente los valores de documento para una vista de documento determinada, se almacenan en la vista asociada.

El mandato query userParameter devuelve el valor del parámetro de usuario en el ámbito especificado si está disponible, de lo contrario devuelve el valor de ámbito superior.

Ejemplos

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 

Consulta relacionada
Mandato query
Mandato set
Parámetro defaultProfile