userParameter パラメーター

userParameter は、エディター拡張機能のプログラマーにとって便利なパラメーターです。 このパラメーターを使用すると、さまざまな有効範囲レベルで、エディター・パラメーターに類似した方法で、 エディターにさまざまな設定を関連付けることができます。

使用できるコマンド

query コマンド
set コマンド

有効範囲

userParameter.view. の有効範囲は現行ビューです。
userParameter.document. の有効範囲は現行ビューの文書です。
userParameter の有効範囲はグローバルです。

構文

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

パラメーター

view. ユーザー・パラメーターの有効範囲として現行ビューを 指定する場合は、view. 修飾子を使用します。
document. ユーザー・パラメーターの有効範囲として現行ビューの文書を 指定する場合は、document. 修飾子を使用します。
name ユーザー・パラメーターの名前を指定する場合は、name パラメーターを使用します。
value ユーザー・パラメーターの値を指定する場合は、value パラメーターを使用します。 value には制限はありません。 set userParameter コマンドに値を指定しない場合は、指定されたビュー、文書、 またはグローバルな有効範囲でのユーザー・パラメーター設定が除去されます。 このユーザー・パラメーターのより大きい有効範囲値がある場合は、その値が復元されます。

説明

有効範囲がグローバルに設定されたユーザー・パラメーター設定は、 エディター・デフォルト・プロファイルに保管されます (『defaultProfile エディター・パラメーター』を参照)。 有効範囲が文書によって設定されたユーザー・パラメーター設定 (特定の文書のグローバル設定を オーバーライドする) は、関連文書に保管されます。 有効範囲がビューによって設定されたユーザー・パラメーター設定 (特定の文書ビューの文書設定を オーバーライドする) は、関連ビューに保管されます。

query userParameter コマンドは、 指定された有効範囲でのユーザー・パラメーターの設定を戻します (該当する場合)。 該当しない場合は、より高い有効範囲の設定を戻します。

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 コマンド
set コマンド
defaultProfile パラメーター