Parâmetro userParameter

userParameter é um parâmetro de conveniência para programadores de extensão do editor. Ele permite que você associe várias configurações ao editor, em diferentes níveis de escopo, de modo semelhante aos parâmetros do editor.

Disponibilidade

comando query
comando set

Escopo

É utilizado o escopo de userParameter.view. para a visualização atual.
É utilizado o escopo de userParameter.document. para a visualização atual.
É utilizado o escopo de userParameter globalmente.

Sintaxe

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

Parâmetros

view. Utilize o qualificador view. para especificar a visualização atual como o escopo do parâmetro do usuário.
document. Utilize o qualificador document. para especificar o documento de visualização atual como o escopo do parâmetro do usuário.
name Utilize o parâmetro name para especificar o nome do parâmetro do usuário.
value Utilize o parâmetro value para especificar o valor do parâmetro do usuário. Não há restrições quanto a value. Se você não especificar um valor para o comando set userParameter, a definição de parâmetro do usuário na visualização, no documento ou no escopo global especificado será removido; o valor mais alto do escopo desse parâmetro do usuário, se houver, será restaurado.

Descrição

As configurações de parâmetro do usuário utilizadas globalmente como escopo são armazenadas no perfil de padrões do editor (consulte o parâmetro do editor defaultProfile). As configurações de parâmetro do usuário utilizadas como escopo no documento, que substituem as configurações globais de um documento específico, são armazenadas no documento associado. As configurações de parâmetro do usuário utilizadas como escopo na visualização, que substituem as configurações de uma visualização do documento específica, são armazenadas na visualização associada.

O comando query userParameter retorna a definição do parâmetro do usuário no escopo especificado, se disponível; caso contrário, ele retorna a definição de escopo mais alta.

Exemplos

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 

Referência relacionada
comando query
comando set
Parâmetro defaultProfile