Paramètre userParameter

Le paramètre userParameter est un paramètre couramment utilisé par les programmeurs d'extension d'éditeur.Il permet d'associer divers paramètres à l'éditeur, à des niveaux de portée différents, de la même manière que les paramètres de l'éditeur.

Disponibilité

Commande query
Commande set

Portée

userParameter.view. est appliqué à la vue courante.
userParameter.document. est appliqué au document de la vue courante.
userParameter est appliqué de manière globale.

Syntaxe

query userParameter.[ view. | document. ] nom
set userParameter.[ view. | document. ] nom [ valeur ] 

Paramètres

view. Le qualificatif view. permet de spécifier la vue courante comme portée des paramètres utilisateur.
document. Le qualificatif document. permet de spécifier le document de la vue courante comme portée des paramètres utilisateur.
nom Le paramètre nom permet de spécifier le nom du paramètre de l'utilisateur.
valeur Le paramètre valeur permet de spécifier la valeur du paramètre utilisateur.Aucune restriction n'est appliquée au paramètre valeur.Si vous ne spécifiez pas de valeur dans la commande set userParameter, le paramètre utilisateur est supprimé au niveau de la vue, du document ou au globalement ; la valeur de la portée supérieure, s'il en existe une, est restaurée.

Description

Les paramètres utilisateur de portée générale sont stockés dans le profil par défaut de l'éditeur (voir le paramètre d'éditeur defaultProfile).Les paramètres utilisateur dont la portée est le document et qui remplacent les paramètres généraux dans un document particulier sont stockés dans le document associé.Les paramètres utilisateur dont la portée est la vue et qui remplacent les paramètres du document dans une vue de document particulière sont stockés dans la vue associée.

La commande query userParameter renvoie le paramètre utilisateur qui se trouve à la portée spécifiée s'il est disponible et le paramètre de portée supérieure dans le cas contraire.

Exemples

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 

Références connexes
Commande query
Commande set
Paramètre defaultProfile